About
Retrieve details of your calls with any one of the following requests. Configure Numbers using our Configure Numbers request. Find new numbers with our Find Numbers request.
Resource URI
Complete details about your calls are requested with any one of the following requests. Requests are either for a single call, calls associated with a property, or more comprehensively associated with an account. Calls are sorted from earliest to latest in each response.
GET
/v2/Calls/[CallSid]
or
/v2/Properties/[PropertySid]/Calls
or
/v2/Accounts/[AccountSid]/Calls
Request
URI Parameters
| Parameter | Type | Description |
|---|---|---|
| CallSid | string | Call secure identifier to retrieve a single record of. |
| PropertySid | string | Property secure identification to retrieve call details against. |
| AccountSid | string | Account secure identification to retrieve call details against. |
Optional Include Parameters
These resource parameters are to filter the call details if multiple calls are requested, can be used in combination with each other.
| Parameter | Type | Description |
|---|---|---|
| Date_From (Unix timestamp) |
unsigned integer | Include calls after the specified date and time (inclusive). |
| Date_To (Unix timestamp) |
unsigned integer | Include calls before the specified date and time (exclusive). |
| Token | string | Server side point in time reference. Can be used instead of Date_From and Date_To, using a token will fetch any new calls written to the database since the time of token query. Tokens are generated in each get call API response, recommended for integrations. |
| Disposition | string | Comma delimited call statuses to include. May be: Answered : Call was successfully answered. IVR : Call received an interactive voice recording. Busy : Call received a busy response. NoAnswer : Call was not answered. Failed : Call did not reach endpoint. |
| To | String | Comma delimited dialled numbers to include. |
| Endpoint | String | Comma delimited endpoint numbers to include. |
| Attribution_Source | string | Comma delimited source attributes to include. |
| Attribution_Medium | string | Comma delimited medium attributes to include. |
| Attribution_Campaign | string | Comma delimited campaign attributes to include. |
| Attribution_Content | string | Comma delimited content attributes to include. |
| Prompts_keys | string | Semi-colon delimited prompt (IVR) keys to include. Nested IVRs can be specified using a comma, for example: Nested IVR: 1,2 Multiple Nested IVRs: 1,2;3,5 |
| Unique | string | Results can be limited to either unique callers or repeat callers. May be: All : All calls will be included. Unique : Calls from a new, unique caller will be returned. Repeat : Calls from a repeat caller identity will be returned. |
| Results_Count | int | Limit the results to this number. Default result count is a limit of 200. |
| Results_Skip | int | Return results after the specified index. This enables custom pagination of results. |
Response
200 – OK
Our service will respond to every call details request with JSON formatted data. Requests for call details will respond with either a single object or a list of objects containing the following parameters.
Common Response Parameters
| Parameter | Type | Description |
|---|---|---|
| CallSid | string | A secure identifier for this call. |
| PropertySid | string | The property identification associated with the call. |
| Date_Start (Unix timestamp) |
string | The date time the call started. |
| From (E.164 Format) |
string | The caller identification. If irretrievable, ‘anonymous’ is assigned as the caller identification. |
| From_CountryCode | string | The country code of the call origin. E.g AU or US |
| From_Region | string | The region of the call origin. |
| From_City | string | The city of the call origin. |
| To (E.164 Format) |
string | The number dialed by the caller. |
| To_Friendly | string | Endpoint number friendly name if configured. |
| Duration | integer | Call duration in seconds. |
| Disposition | string | The resulting call disposition. May be: Answered : Call was successfully answered. IVR : Call received an interactive voice recording. Busy : Call received a busy response. NoAnswer : Call was not answered. Failed : Call did not reach endpoint. |
| Recording_Uri | string | A uri for retrieving the recording. If enabled and the call was successful. |
| Endpoint | string | The endpoint reached by the call. If the call was routed to an endpoint. |
| Attribution_Source | string | The call was attributed to this source. |
| Attribution_Medium | string | The call was attributed to this medium. |
| Attribution_Campaign | string | The call was attributed to this campaign. |
| Attribution_Content | string | The call was attributed to this content. |
| Session_Traffic_Type | string | The traffic type associated with the session attributing to the call. If a dynamic number. May be: Campaign : A campaign source. Direct : Site was directly accessed. Organic : General search or browsing. Referral : The session was the result of referral. Unattributed : No attributable source for the session. |
| Session_Keywords | string | Keywords entered in the session, attributing to the call. |
| Session_ConversionUri | string | The uri extension the call was conducted from. |
| Session_LandingUri | string | The uri landing page where the session was created. |
| Survey_Type | string | The survey type key assigned to this call. This is a routing configurable key. If assigned. |
| Survey_Value | string | The survey value assigned to this call. This is a call specific configurable number. If assigned. |
| Survey_Custom1 | string | A custom call field assignable during routing. If assigned. |
| Survey_Custom2 | string | A custom call field assignable during routing. If assigned. |
| Survey_Custom3 | string | A custom call field assignable during routing. If assigned. |
| Survey_UniqueCode | string | A custom call unique code generated. If assigned. |
| Prompts_Keys | string | Keys pressed during an interactive voice response. If applicable. |
| Notes | string | Custom notes describing this call. |
| CallType | string | Custom call type. |
| Token | string | Incremental API Token which can be used instead of the Date_From and Date_To paramaters. Tokens are generated from the time of the API request and provide a server side point in time reference. |
Integration Response Parameters
| Parameter | Type | Description |
|---|---|---|
| Google_Analytics_ClientId | string | Google Analytics Client id associated with the session. If Google Analytics integration is enabled. |
| Google_Adwords_ClickId | string | Google Adwords Click Id associated with the session. If Google Adwords integration is enabled. |
400 - Error
For error codes and messages, please refer to the REST API Error Codes page.