Jump to

• Request
• Response

Create a phone call

post

/crmRestApi/resources/11.13.18.05/phoneCalls

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CallDetailsURL: string
  Title: Call Details URL

  Maximum Length: 1000

  The external web address of the phone call details.
• CallNumber: string
  Title: Call Number

  Maximum Length: 30

  The public unique identifier for a phone call.
• CallRecording: string (byte)
  Title: Call Recording

  The phone call recording.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the phone call was deleted.
• ExternalSystemCallId: string
  Title: External Call ID

  Maximum Length: 255

  The phone call identifier as defined by the telephony provider system.
• InteractionId(required): integer (int64)
  Title: Interaction ID

  The unique identifier for the interaction record for the phone call.
• LeftMessageFlag: boolean
  Title: Left Message

  Maximum Length: 1

  Indicates whether a voice mail message was left.
• PhoneNumber: string
  Title: Phone Number

  Maximum Length: 30

  The external phone number for the phone call.
• RecordingFormat: string
  Title: Recording Format

  Maximum Length: 64

  The media type format of the phone call recording.
• RecordingURL: string
  Title: Recording URL

  Maximum Length: 1000

  The external web address of the phone call recording.
• TranscriptMessage: array Phone Transcript Messages
  Title: Phone Transcript Messages

  Indicates the messages that constitute the phone call transcript.
• TranscriptURL: string
  Title: Transcript URL

  Maximum Length: 1000

  The external web address of the phone call transcript.

{
    "required":[
        "InteractionId"
    ],
    "type":"object",
    "properties":{
        "CallDetailsURL":{
            "title":"Call Details URL",
            "maxLength":1000,
            "type":"string",
            "description":"The external web address of the phone call details.",
            "nullable":true
        },
        "CallNumber":{
            "title":"Call Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier for a phone call.",
            "nullable":false
        },
        "CallRecording":{
            "title":"Call Recording",
            "type":"string",
            "description":"The phone call recording.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the phone call was deleted.",
            "nullable":false,
            "default":false
        },
        "ExternalSystemCallId":{
            "title":"External Call ID",
            "maxLength":255,
            "type":"string",
            "description":"The phone call identifier as defined by the telephony provider system.",
            "nullable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier for the interaction record for the phone call.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "LeftMessageFlag":{
            "title":"Left Message",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a voice mail message was left.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":30,
            "type":"string",
            "description":"The external phone number for the phone call.",
            "nullable":true
        },
        "RecordingFormat":{
            "title":"Recording Format",
            "maxLength":64,
            "type":"string",
            "description":"The media type format of the phone call recording.",
            "nullable":true
        },
        "RecordingURL":{
            "title":"Recording URL",
            "maxLength":1000,
            "type":"string",
            "description":"The external web address of the phone call recording.",
            "nullable":true
        },
        "TranscriptMessage":{
            "title":"Phone Transcript Messages",
            "type":"array",
            "description":"Indicates the messages that constitute the phone call transcript.",
            "items":{
                "$ref":"#/components/schemas/phoneCalls-TranscriptMessage-item-post-request"
            }
        },
        "TranscriptURL":{
            "title":"Transcript URL",
            "maxLength":1000,
            "type":"string",
            "description":"The external web address of the phone call transcript.",
            "nullable":true
        }
    }
}

Nested Schema : Phone Transcript Messages

Type: array

Title: Phone Transcript Messages

Indicates the messages that constitute the phone call transcript.

Show Source

• Array of: object phoneCalls-TranscriptMessage-item-post-request

{
    "title":"Phone Transcript Messages",
    "type":"array",
    "description":"Indicates the messages that constitute the phone call transcript.",
    "items":{
        "$ref":"#/components/schemas/phoneCalls-TranscriptMessage-item-post-request"
    }
}

Nested Schema : phoneCalls-TranscriptMessage-item-post-request

Type: object

Show Source

• CallId: integer (int64)
  Title: Call ID

  The phone call identifier for the transcript message.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the phone call transcript message was deleted or not.
• MessageContent: string (byte)
  Title: Message

  The content of the phone call transcript message.
• MessageId: integer (int64)
  Title: Message ID

  The unique identifier for a phone call transcript message.
• MessageNumber: string
  Title: Message Number

  Maximum Length: 30

  The public unique identifier for a phone call transcript message.
• MessageTypeCd: string
  Title: Message Type

  Maximum Length: 30

  The type of message.
• PostedByDisplayName: string
  Title: Posted By

  Maximum Length: 64

  The name of the message poster for display.
• PostedByPartyId: string
  Title: Contact ID

  Maximum Length: 30

  The party identifier of the message poster.
• RoleCd: string
  Title: Role

  Maximum Length: 30

  The role type of the message poster.
• VisibilityCd: string
  Title: Visibility

  Maximum Length: 30

  The visibility of the phone call transcript message.

{
    "type":"object",
    "properties":{
        "CallId":{
            "title":"Call ID",
            "type":"integer",
            "description":"The phone call identifier for the transcript message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the phone call transcript message was deleted or not.",
            "nullable":false,
            "default":false
        },
        "MessageContent":{
            "title":"Message",
            "type":"string",
            "description":"The content of the phone call transcript message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier for a phone call transcript message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier for a phone call transcript message.",
            "nullable":false
        },
        "MessageTypeCd":{
            "title":"Message Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of message.",
            "nullable":true
        },
        "PostedByDisplayName":{
            "title":"Posted By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the message poster for display.",
            "nullable":true
        },
        "PostedByPartyId":{
            "title":"Contact ID",
            "maxLength":30,
            "type":"string",
            "description":"The party identifier of the message poster.",
            "nullable":true
        },
        "RoleCd":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The role type of the message poster.",
            "nullable":true
        },
        "VisibilityCd":{
            "title":"Visibility",
            "maxLength":30,
            "type":"string",
            "description":"The visibility of the phone call transcript message.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : phoneCalls-item-response

Type: object

Show Source

• CallDetailsURL: string
  Title: Call Details URL

  Maximum Length: 1000

  The external web address of the phone call details.
• CallId: integer (int64)
  Title: Call ID

  Read Only: true

  The unique identifier for a phone call.
• CallNumber: string
  Title: Call Number

  Maximum Length: 30

  The public unique identifier for a phone call.
• CallRecording: string (byte)
  Title: Call Recording

  The phone call recording.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the phone call.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the phone call was created.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the phone call was deleted.
• ExternalSystemCallId: string
  Title: External Call ID

  Maximum Length: 255

  The phone call identifier as defined by the telephony provider system.
• InteractionId: integer (int64)
  Title: Interaction ID

  The unique identifier for the interaction record for the phone call.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the phone call was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the phone call.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the phone call.
• LeftMessageFlag: boolean
  Title: Left Message

  Maximum Length: 1

  Indicates whether a voice mail message was left.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhoneNumber: string
  Title: Phone Number

  Maximum Length: 30

  The external phone number for the phone call.
• RecordingFormat: string
  Title: Recording Format

  Maximum Length: 64

  The media type format of the phone call recording.
• RecordingURL: string
  Title: Recording URL

  Maximum Length: 1000

  The external web address of the phone call recording.
• TranscriptMessage: array Phone Transcript Messages
  Title: Phone Transcript Messages

  Indicates the messages that constitute the phone call transcript.
• TranscriptURL: string
  Title: Transcript URL

  Maximum Length: 1000

  The external web address of the phone call transcript.

{
    "type":"object",
    "properties":{
        "CallDetailsURL":{
            "title":"Call Details URL",
            "maxLength":1000,
            "type":"string",
            "description":"The external web address of the phone call details.",
            "nullable":true,
            "x-queryable":true
        },
        "CallId":{
            "title":"Call ID",
            "type":"integer",
            "description":"The unique identifier for a phone call.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CallNumber":{
            "title":"Call Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier for a phone call.",
            "nullable":false,
            "x-queryable":true
        },
        "CallRecording":{
            "title":"Call Recording",
            "type":"string",
            "description":"The phone call recording.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the phone call.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the phone call was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the phone call was deleted.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ExternalSystemCallId":{
            "title":"External Call ID",
            "maxLength":255,
            "type":"string",
            "description":"The phone call identifier as defined by the telephony provider system.",
            "nullable":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier for the interaction record for the phone call.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the phone call was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the phone call.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the phone call.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeftMessageFlag":{
            "title":"Left Message",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a voice mail message was left.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":30,
            "type":"string",
            "description":"The external phone number for the phone call.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordingFormat":{
            "title":"Recording Format",
            "maxLength":64,
            "type":"string",
            "description":"The media type format of the phone call recording.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordingURL":{
            "title":"Recording URL",
            "maxLength":1000,
            "type":"string",
            "description":"The external web address of the phone call recording.",
            "nullable":true,
            "x-queryable":true
        },
        "TranscriptMessage":{
            "title":"Phone Transcript Messages",
            "type":"array",
            "description":"Indicates the messages that constitute the phone call transcript.",
            "items":{
                "$ref":"#/components/schemas/phoneCalls-TranscriptMessage-item-response"
            }
        },
        "TranscriptURL":{
            "title":"Transcript URL",
            "maxLength":1000,
            "type":"string",
            "description":"The external web address of the phone call transcript.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Phone Transcript Messages

Type: array

Title: Phone Transcript Messages

Indicates the messages that constitute the phone call transcript.

Show Source

• Array of: object phoneCalls-TranscriptMessage-item-response

{
    "title":"Phone Transcript Messages",
    "type":"array",
    "description":"Indicates the messages that constitute the phone call transcript.",
    "items":{
        "$ref":"#/components/schemas/phoneCalls-TranscriptMessage-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : phoneCalls-TranscriptMessage-item-response

Type: object

Show Source

• CallId: integer (int64)
  Title: Call ID

  The phone call identifier for the transcript message.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the phone transcript message.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the phone transcript message was created.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the phone call transcript message was deleted or not.
• InteractionId: integer (int64)
  Title: Interaction ID

  Read Only: true

  The interaction identifier for the phone transcript message.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the phone transcript message was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the phone transcript message.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the phone transcript message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageContent: string (byte)
  Title: Message

  The content of the phone call transcript message.
• MessageId: integer (int64)
  Title: Message ID

  The unique identifier for a phone call transcript message.
• MessageNumber: string
  Title: Message Number

  Maximum Length: 30

  The public unique identifier for a phone call transcript message.
• MessageTypeCd: string
  Title: Message Type

  Maximum Length: 30

  The type of message.
• PostedByDisplayName: string
  Title: Posted By

  Maximum Length: 64

  The name of the message poster for display.
• PostedByPartyId: string
  Title: Contact ID

  Maximum Length: 30

  The party identifier of the message poster.
• RoleCd: string
  Title: Role

  Maximum Length: 30

  The role type of the message poster.
• VisibilityCd: string
  Title: Visibility

  Maximum Length: 30

  The visibility of the phone call transcript message.

{
    "type":"object",
    "properties":{
        "CallId":{
            "title":"Call ID",
            "type":"integer",
            "description":"The phone call identifier for the transcript message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the phone transcript message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the phone transcript message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the phone call transcript message was deleted or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The interaction identifier for the phone transcript message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the phone transcript message was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the phone transcript message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the phone transcript message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageContent":{
            "title":"Message",
            "type":"string",
            "description":"The content of the phone call transcript message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MessageId":{
            "title":"Message ID",
            "type":"integer",
            "description":"The unique identifier for a phone call transcript message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier for a phone call transcript message.",
            "nullable":false,
            "x-queryable":true
        },
        "MessageTypeCd":{
            "title":"Message Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of message.",
            "nullable":true,
            "x-queryable":true
        },
        "PostedByDisplayName":{
            "title":"Posted By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the message poster for display.",
            "nullable":true,
            "x-queryable":true
        },
        "PostedByPartyId":{
            "title":"Contact ID",
            "maxLength":30,
            "type":"string",
            "description":"The party identifier of the message poster.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleCd":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The role type of the message poster.",
            "nullable":true,
            "x-queryable":true
        },
        "VisibilityCd":{
            "title":"Visibility",
            "maxLength":30,
            "type":"string",
            "description":"The visibility of the phone call transcript message.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

TranscriptMessage

Operation: /crmRestApi/resources/11.13.18.05/phoneCalls/{CallId}/child/TranscriptMessage

Parameters:

• CallId: $request.path.CallId

Indicates the messages that constitute the phone call transcript.

Back to Top