Calls.list

Returns all defined Calls

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted Calls are returned as well

first

integer <int32>

optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

last

integer <int32>

optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

before

string

optional

Cursor until which to take entities to result set.

after

string

optional

Cursor after which to start taking entities to result set.

expand

string

optional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example:

expand=owner,sales_unit,account_relations.account

order-by

string

optional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example:

order-by=created,-modified

load-only

string

optional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example:

load-only=id,name,owner.id

Responses

🟢200OK

application/json

list of Calls

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (Call) {29}]

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

account

string <uri>

optional

Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.

caller

string <uri>

required

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

client

string <uri>

optional

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

contact

string <uri>

optional

Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.

lead

string <uri>

optional

Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.

oppty

string <uri>

optional

Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.

oppty_product_relation

string <uri>

optional

Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties.

product

string <uri>

optional

Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties.

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

caller_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

client_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

lead_oppty_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_product_relation_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

phone_number

string

optional

Phone number.

Example:

string

product_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

transcription_id

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

transcription_language

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

transcription_summary

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

twilio_call_log_id

string <uuid>

required

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

01234567-abcd-dcba-ffff-000000000000

transcription_file_id

string <uuid>

optional

Example:

01234567-abcd-dcba-ffff-000000000000

audio_id

string <uuid>

optional

Example:

01234567-abcd-dcba-ffff-000000000000

twilio_call_sid

string

required

Example:

string

audio_status

enum<string>

required

This is small hack to force creation of MediaEntity upon Call creation.
This field cannot be actually set. Instead, CallRepository.create method handles media creation,
if requested.

Allowed values:

NoRecordingTranscriptionCompletedTranscriptionEmptyTranscriptionErrorTranscriptionInProgressUploadErrorUploadedUploading

Example:

NoRecording

page_info

object

optional

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

start_cursor

string

optional

Start cursor of result set.

Example:

WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==

end_cursor

string

optional

End cursor of result set.

Example:

WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==

has_previous_page

boolean

optional

If result set has previous page (if yes, use start_cursor value in before parameter to load it).

Example:

true

has_next_page

boolean

optional

If result set has next page (if yes, use end_cursor value in after parameter to load it).

Example:

true

Example

{
  "success": true,
  "data": [
    {
      "is_delete_protected": false,
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "is_deleted": false,
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "account": "http://example.com",
      "caller": "http://example.com",
      "client": "http://example.com",
      "contact": "http://example.com",
      "lead": "http://example.com",
      "oppty": "http://example.com",
      "oppty_product_relation": "http://example.com",
      "product": "http://example.com",
      "account_id": "01234567-abcd-dcba-ffff-000000000000",
      "caller_id": "01234567-abcd-dcba-ffff-000000000000",
      "client_id": "01234567-abcd-dcba-ffff-000000000000",
      "contact_id": "01234567-abcd-dcba-ffff-000000000000",
      "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
      "oppty_product_relation_id": "01234567-abcd-dcba-ffff-000000000000",
      "phone_number": "string",
      "product_id": "01234567-abcd-dcba-ffff-000000000000",
      "transcription_id": "string",
      "transcription_language": "string",
      "transcription_summary": "string",
      "twilio_call_log_id": "01234567-abcd-dcba-ffff-000000000000",
      "transcription_file_id": "01234567-abcd-dcba-ffff-000000000000",
      "audio_id": "01234567-abcd-dcba-ffff-000000000000",
      "twilio_call_sid": "string",
      "audio_status": "NoRecording"
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

🔴500Server Error

Request

Request samples

Responses