Calls.create - PipelinerCRM

Creates new Call

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Call on create. Use them as bit mask: 0 - validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,
16 - allows to set entity on deleted relationship.

Body Params application / json

oppty_product_relation

object

optional

Relation to OpptyProductRelation, see: 'createOpptyProductRelationInput' object for properties.

string <uri>

optional

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

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

Example

{
    "oppty_product_relation": {
        "id": "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",
    "audio_status": "NoRecording"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created Call

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Call)

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

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"
    }
}

🔴500Server Error