Jump to

• Request
• Response

Get all phone transcript messages

get

/crmRestApi/resources/11.13.18.05/phoneTranscriptMessages

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a phone transcript message with the specified primary key.
    Finder Variables
    • MessageId; integer; The primary key of the phone transcript message.
  • findByCallId Finds a phone transcript messages with the given call identifier.
    Finder Variables
    • BindCallId; string; The unique identifier of the call.
  • findByInteractionId Finds phone transcript messages for the given interaction identifier.
    Finder Variables
    • BindInteractionId; string; The unique identifier of the interaction.
  • findByMessageId Finds a phone transcript message for the with the given message identifier.
    Finder Variables
    • MessageId; integer; The unique identifier of the message.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CallId; integer; The phone call identifier for the transcript message.
  • CreatedBy; string; The user who created the phone transcript message.
  • CreationDate; string; The date and time the phone transcript message was created.
  • DeletedFlag; boolean; Indicates whether the phone call transcript message was deleted or not.
  • InteractionId; integer; The interaction identifier for the phone transcript message.
  • LastUpdateDate; string; The date and time the phone transcript message was last updated.
  • LastUpdateLogin; string; The session login of the user who last updated the phone transcript message.
  • LastUpdatedBy; string; The user who last updated the phone transcript message.
  • MessageId; integer; The unique identifier for a phone call transcript message.
  • MessageNumber; string; The public unique identifier for a phone call transcript message.
  • MessageTypeCd; string; The type of message.
  • PostedByDisplayName; string; The name of the message poster for display.
  • PostedByPartyId; string; The party identifier of the message poster.
  • RoleCd; string; The role type of the message poster.
  • VisibilityCd; string; The visibility of the phone call transcript message.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 : phoneTranscriptMessages

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/phoneTranscriptMessages-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object phoneTranscriptMessages-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/phoneTranscriptMessages-item-response"
    }
}

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

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

Back to Top