Jump to

• Request
• Response

Get a phone call

get

/crmRestApi/resources/11.13.18.05/phoneCalls/{CallId}

Request

Path Parameters

• CallId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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