Call

/v0.1/Call/

Initiates an outbound call

post/v0.1/Call/

Request

Base URL
https://eqivo.org (the document declares no server; this is the origin it was published from)
Auth
HTTP basic
TypeScript
https://skmtc.dev/eqivo/apis/eqivo-api/docs/v0.1/Call/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

Fromstring required

Phone number to be used as Caller ID

Tostring required

Phone number to be called

Gatewaysstring required

Comma separated FreeSWITCH gateway strings. When multiple gateways are specified, they will be tried sequentially (failover)

AnswerUrlstring required

Fully qualified URL which will provide the RestXML once the call connects

CallerNamestring

Caller Name to be set for the call

HangupUrlstring

Fully qualified URL to which the call hangup notification will be POSTed. HangupCause is added to the usual call call notification parameters

RingUrlstring

Fully qualified URL to which the call ringing notification will be POSTed. RequestUUID and CallUUID is added to the usual call notification parameters

ExtraDialStringstring

Additional channel variables to be added to the originate FreeSWITCH API call.

GatewayCodecsstring

List of codec(s) to be used for each gateway. Enclose codec groups in single quotes

GatewayTimeoutsstring

List of maximum timeout amounts (in seconds) for each gateway

GatewayRetriesstring

List of maximum retry counts for each gateway

SendDigitsstring

DTMF tones to be sent when the call is answered. Each occurrence of w implies a 0.5 seconds delay whereas W will apply a whole second delay. To alter the tone duration (by default, 2000ms), append @ and the length in milliseconds at the end of the string

SendOnPreanswerboolean

When set to true, DTMF tones will be sent as early media rather than when the call is answered

TimeLimitinteger

Schedules the call's hangup at a given time offset (in seconds) after the call is answered

HangupOnRinginteger

Schedules the call's hangup at a given time offset (in seconds) after the destination starts ringing

CoreUUIDstring

Core UUID of the desired FreeSWITCH instance (an Eqivo extension)

MachineDetection'Enable' | 'DetectMessageEnd'

Enables answering machine detection; optionally, it waits until the greeting message has been played back (an Eqivo extension)

AsyncAMDboolean

When set to true, the call flow execution is blocked until answering machine detection is complete (an Eqivo extension)

AsyncAmdStatusCallbackMethod'POST' | 'GET'

HTTP method to be used when answering machine detection is completed (an Eqivo extension)

AsyncAmdStatusCallbackstring

Fully qualified URL to which the answering machine detection result will be sent. AnsweredBy and MachineDetectionDuration are appended to the usual call notification parameters (an Eqivo extension)

MachineDetectionTimeoutinteger

Amount of time (in seconds) allotted for answering machine detection assessment (an Eqivo extension)

MachineDetectionSpeechThresholdinteger

Speech activity/utterance threshold (in milliseconds, an Eqivo extension)

MachineDetectionSpeechEndThresholdinteger

Silence threshold (in milliseconds, an Eqivo extension)

MachineDetectionSilenceTimeoutinteger

Initial silence threshold (in milliseconds, an Eqivo extension)

Example request

{
  "From": "15551234567",
  "To": "15557654321",
  "Gateways": "user/,sofia/gateway/PSTNgateway1/,sofia/gateway/PSTNgateway2/",
  "AnswerUrl": "https://example.com/answer/",
  "CallerName": "Test",
  "HangupUrl": "https://example.com/hangup/",
  "RingUrl": "https://example.com/ring/",
  "ExtraDialString": "bridge_early_media=true,hangup_after_bridge=true",
  "GatewayCodecs": "'PCMA,PCMU','G729,PCMU','PCMA,G729'",
  "GatewayTimeouts": "10,30,20",
  "GatewayRetries": "3,1,2",
  "SendDigits": "1w2w3W#*@1500",
  "TimeLimit": 90,
  "HangupOnRing": 90,
  "CoreUUID": "45521fc6-a4b3-42b6-96ad-9136256be216",
  "MachineDetection": "Enable",
  "AsyncAMD": true,
  "AsyncAmdStatusCallbackMethod": "GET",
  "MachineDetectionTimeout": 5,
  "MachineDetectionSpeechThreshold": 2000,
  "MachineDetectionSpeechEndThreshold": 1000,
  "MachineDetectionSilenceTimeout": 3000
}

Response

Response message

RequestUUIDstring required

Unique identifier of the Call request (UUIDv4)

Successboolean required

Whether the request was successful or not

RestApiServerstring required

API server which handled this request (an Eqivo extension)

Example response

{
  "Message": "Call Request Executed",
  "RequestUUID": "fc92f3f4-3777-43ed-b269-5b4a0d474b12",
  "Success": true,
  "RestApiServer": "localhost"
}

Changes

No recorded changes to this operation across all 1 revision of this API.