Get Call Transfer

Get Call Transfer resource by ID.

Authorizations

asapp-api-id · string · header · required

asapp-api-secret · string · header · required

Path Parameters

callTransferId · string · required

The identifier for the call transfer.

Response

200

application/json

Successful response

Get Call Transfer Response

id · string · required

The unique identifier for this call transfer request.

Example:

"0867617078-0032318833-2221801472-0002236962"

externalConversationId · string · required

The unique identifier of the call in your call system. This will be referenced in ASAPP reporting.

Example:

"0867617078-0032318833-2221801472-0002236962"

status · enum<string> · required

The current status of the call transfer request.

• ACTIVE: The call transfer request has been created and is waiting for your system to transfer the call.
• ONGOING: The call transfer has been received by ASAPP and is currently in progress. The phone number is no longer assigned to the call transfer request.
• COMPLETED: The call transfer has been successfully completed. The output context will be returned.
• EXPIRED: The call transfer request is no longer valid (e.g., the phone number expired).

Available options:

ACTIVE,

ONGOING,

COMPLETED,

EXPIRED

createdAt · string · required

Timestamp (ISO 8601) when the call transfer resource was created.

Example:

"2024-06-01T12:34:56Z"

type · enum<string> · required

The type of call transfer method that was used.

Available options:

PHONE_NUMBER,

SIP

callReceivedAt · string

Timestamp (ISO 8601) when the call transfer was received by ASAPP.

Example:

"2024-06-01T12:34:56Z"

completedAt · string

Timestamp (ISO 8601) when the call transfer was completed by the Generative Agent.

Example:

"2024-06-01T12:34:56Z"

inputContext · object

The context information that was passed to the Generative Agent when the call was received.

Show child attributes

Example:

{
  "taskName": "welcome",
  "variables": {
    "email": "[e-mail]",
    "name": "name"
  }
}

outputContext · object

The context information from the Generative Agent when the call ended.

Show child attributes

Example:

{
  "currentTaskName": "welcome",
  "referenceVariables": {
    "reference_variable_1": "reference_value_1",
    "reference_variable_2": "reference_value_2"
  },
  "transferVariables": {
    "transfer_variable_1": "transfer_value_1",
    "transfer_variable_2": "transfer_value_2"
  }
}

phoneNumber · object

Details about the assigned phone number for the transfer, including the number to dial and when it expires. Only available if type is PHONE_NUMBER.

Show child attributes

sip · object

Configuration for SIP transfers. Defines how the call will be transferred back when the Generative Agent finishes the conversation.

Transfer Types:

• BYE: Ends the call with a SIP BYE message. Use for supervised transfers to Generative Agent.
• REFER: Sends a SIP REFER message with the return URI in the Refer-To header. Use for blind transfers to another system.
• INVITE: Initiates a new SIP INVITE to the return URI, ASAPP will continue to transcribe the call until the call is ended.

Show child attributes

Example:

{
  "returnTransferType": "REFER",
  "returnUri": "sip:[e-mail]:5060"
}