Sign in
latestOpenAPI 3.0.3MIT2026-08-124627160.3 KB

c04c2c708bf9

Calls

Export call records

Export call records for a project. This returns a comma separate value (CSV) response. You can specify which records to export using the query parameters.

get/calls/export

Query parameters

fromstring phonenumber

A phone number that you want to use to filter results. You can pass a partial number to get all calls sent to numbers that start with the number you passed.

tostring phonenumber

Only include calls made to this number or address. You can pass a partial number to get all calls sent to numbers that start with the number you passed.

trunkIdstring

Only include calls made from this trunk.

createTimestring
Example:2021-02-01

Filter calls based on createTime. You make the query more precise, fewer results will be returned. For example, 2021-02-01 will return all calls from the first of February 2021, and 2021-02-01T14:00:00Z will return all calls after 14:00 on the first of February. This field also supports <= and >= to search for calls in a range ?createTime>=2021-10-01&createTime<=2021-10-30 to get a list if calls for october 2021 It is also possible to submit partial dates for example createTime=2021-02 will return all calls for February

Defaults to 24 hours

callResult'COMPLETED' | 'NO_ANSWER' | 'CANCEL' | 'BUSY' | 'FAILED'

The result of the call.

Example:COMPLETED

only include calls by on the callResult(s), example callResult=COMPLETED will return all calls which have completed normally.

direction'INBOUND' | 'OUTBOUND'

Filter results based on the call direction. Describes whether the call was INBOUND to your Sinch number or was OUTBOUND and made from your Sinch number. An INBOUND call can also come from a SIP infrastructure or an application built using the Sinch SDK. An OUTBOUND call can be placed to a SIP infrastructure or an application built using the Sinch SDK.

only include calls by on the direction(s), example direction=INBOUND,OUTBOUND will return all calls that are inbound or outbound.

pageinteger

The page you want to fetch, can set to 1 for first page, or omitted for first page

sizeinteger

The size of each page to fetch

fromCountryCodestring
Example:US

Set this if you want to filter on the country of the caller phone number.

toCountryCodestring
Example:CA

Set this if you want to filter on the country of the callee phone number.

emergencyOnly'true' | 'false'

Set this if you want to filter on emergency calls or not.

regionstring
Example:us-east

Set this is you want to filter calls based on the region.

projectIdsstring

Set this if you want to include calls from other projects.

fileNamestring
groupIdstring
Example:e234bd85-8uv5-44a2-a973-1f705a0960f5@vp3-i-06a73121dc26a8906.xmpp.vpc

Set this if you want to filter calls based on the group ID.

parentIdstring
Example:9128525b-7273-123f-73ae-0225d0254abb

Set this if you want to filter calls based on the call's parent ID.

relationshipTypestring
Example:initial

The type of relationship the call has, for example, an initial call or a child call.

hasChildren'true' | 'false'

Set this if you want to filter on calls with children or not.

Response

OK