Outbound Calls

Retrieve a call

get/api/v1/outbound/calls/{callId}

Request

  • Base URL: https://api.callnode.io
  • URL: https://api.callnode.io/api/v1/outbound/calls/{callId}
  • Auth: API key in header X-Api-Key and API key in header X-Timestamp and API key in header X-Signature

Response

The call.

callIdstring
status'originating' | 'ringing' | 'answered' | 'completed' | 'failed' | 'canceled'
fromstring

Plus sign followed by 7–15 digits.

tostring

The destination as requested — an E.164 number, a sip: URI, or an extension (trunk form).

createdAtstring date-time
originatedAtstring date-time nullable
answeredAtstring date-time nullable
endedAtstring date-time nullable
durationSecsinteger nullable
costUsdstring nullable

Decimal string, e.g. "0.04".

failureCodestring nullable

Why the call failed. no_answer, busy, carrier_rejected, invalid_number, cancelled, max_duration_exceeded, or — for SIP destinations — invalid_destination, endpoint_unreachable, endpoint_rejected.

sipTrunkIdstring nullable

The trunk used for this call. Null for PSTN calls and direct-URI SIP calls.

sipUristring nullable

The normalized SIP URI actually dialed. Null for PSTN calls.

phoneBookExemptboolean

True when the call was placed outside the 8am–9pm window to a number in the account's Phone Book, so no tcpaOverride was needed.

metadataobject

Example response

{
  "from": "+16135551234"
}

Changes

No recorded changes to this operation across all 1 revision of this API.