Skip to content

Move a live phone call to another number

POST
/voice/calls/{trackingId}/transfer
curl --request POST \
--url https://api.pingram.io/voice/calls/example/transfer \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "to": "example", "holdSay": "example", "holdAudio": "example", "receiverSay": "example" }'

Authorizations

Parameters

Path Parameters

trackingId
required
string

Call tracking id

Request Bodyrequired

Media typeapplication/json

Body for POST /voice/calls/{trackingId}/transfer.

object
to
required

E.164 number to move the caller to.

string
holdSay

Spoken once to the caller while they wait. If holdAudio is also set, this sentence plays first and then the audio.

string
holdAudio

builtin:soft-piano, builtin:calm, builtin:bright, or an HTTPS MP3 or WAV. Loops until the call connects. Omit it and the caller hears ringing.

string
receiverSay

Spoken to the person who answers, before the caller is connected.

string
Examplegenerated
{
"to": "example",
"holdSay": "example",
"holdAudio": "example",
"receiverSay": "example"
}

Responses

200

Successful response

Media typeapplication/json
object
message
required
string
Examplegenerated
{
"message": "example"
}

400

Bad Request - validation errors, invalid input

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
"trackingId": "example",
"error": {
"code": "example",
"message": "example",
"fix": "example"
}
}

401

Unauthorized

402

Payment Required - usage limits exceeded

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
"trackingId": "example",
"error": {
"code": "example",
"message": "example",
"fix": "example"
}
}

500

Internal Server Error

502

Bad Gateway - provider error

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
"trackingId": "example",
"error": {
"code": "example",
"message": "example",
"fix": "example"
}
}