Get a leg

Unique identifier for this leg record.

Call identifier shared across all legs of a multi-party or transferred call. Use this to correlate related leg records. null when call correlation is not available for the leg.

Whether the call was placed from your side, by your PBX, the API, the browser or Bird dialing onward for you (outbound), or arrived from a remote party (inbound).

Possible values: inbound, outbound

Calling party number in E.164 format.

Called party number in E.164 format.

Who placed the leg: the API key whose credentials it used, the integration acting for the workspace, or the user who placed it from a browser or the CLI. Absent when the leg was admitted only by its source IP address, or when no actor was recorded.

Identifier of the SIP trunk that originated this leg. null when no trunk is associated.

The SIP Call-ID of this leg's signalling. We relay it unchanged, so it matches what the carrier and your own equipment logged for the same leg: the carrier's value on an incoming leg, and your system's value on a leg you place through a SIP trunk. Use it to match this leg against a carrier's records or your PBX logs. Legs recorded before this field existed carry it only if they were answered.

Call status.

A call that has ended carries one of:

• answered means it connected and the far end picked up.
• no_answer means nobody picked up before the call timed out.
• rejected means it was refused rather than attempted. Either we turned it away before dialing a carrier, in which case rejection_reason names the check it failed where there was one, or the far end declined it.
• failed means it was attempted and did not work, and sip_response_code is what came back.
• unknown means the outcome could not be determined. Contact support with the call id if you see one.

An active call carries ringing before it is picked up and in_progress afterward. The call list's status filter takes any mix of the two sets.

busy and canceled are reserved for incoming calls delivered to your own numbers: busy for a called party that rejected the call as busy, canceled for a caller who hung up before it was picked up. Neither is emitted yet and both outcomes are reported as failed today.

Possible values: answered, no_answer, busy, canceled, failed, rejected, unknown, ringing, in_progress

Final SIP response code received from the carrier. null when no SIP response was received, for example on timeout or DNS failure.

Why we rejected the leg. Absent on connected legs and legs rejected by the carrier or recipient. For carrier or recipient rejections, see sip_response_code; a 6xx decline gives the leg a rejected status.

Read alongside route when present. A refusal caused by the number's configuration has no rejection reason; the route records that configuration.

Possible values: source_not_allowed, caller_id_not_verified, routing_not_configured, no_route_found, destination_blocked, destination_not_enabled, insufficient_balance, daily_spend_exceeded, concurrent_calls_exceeded, calls_per_second_exceeded, call_not_permitted, number_ownership_not_verified

Which answer your number gave an incoming leg. Its type selects the shape, and each answer carries its own fields; the variants below are the full set you can receive. Recorded when the leg was handled, so changing the number's setup afterwards does not change what its past legs say. Absent on outbound legs, and on legs recorded before this field existed.

Your own {name, value} labels for this leg, taken from the X-Bird-Call-Tag headers on the INVITE that placed it. Set them to organise legs by a dimension of your own (campaign, queue, agent, cost centre), then filter this list by them with tag. Read-only here: a leg is labelled when it is placed, and never afterwards. What is here may be less than what was sent, and the leg still goes through either way: a tag whose name or value breaks the rules below is dropped, anything past the first five is ignored, and a name sent more than once keeps its first value. Absent when the leg carried none, and on legs recorded before this field existed.

When the leg was initiated.

When the leg was answered (200 OK received). null for unanswered legs.

When the leg ended (BYE or final non-2xx response). null for legs that ended abnormally without a recorded end event.

Total leg duration in milliseconds, measured from the first INVITE to the BYE or final response. null while the leg is still in progress and has no final duration yet.

Post-dial delay in milliseconds: how long the caller heard nothing between dialing and the phone starting to ring at the other end. High values are what callers experience as the leg not going through. Absent when the leg never rang, either because it failed first or because the carrier answered it immediately.

Billable duration in milliseconds, measured from answer to leg end. Zero for unanswered legs, and null while the leg is still in progress.

How the audio sounded, as opposed to whether the leg connected. Absent when the leg carried no audio, or when the far end reported nothing to measure from.

What the leg cost, net of tax, at full precision, split into the components that make it up. Absent until the leg has been rated; unanswered or unpriced legs have no cost, and neither does a verification call Bird places and answers on your behalf, which is exempt from rating.