Call

/v0.1/BulkCall/

Initiates multiple concurrent outbound calls

post/v0.1/BulkCall/

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/BulkCall/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

Delimiterstring required

Any character, except / and ,, which will be used as a separator within several parameters

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

RejectCausesstring

Comma separated reject causes

CallerNamestring

Caller Name to be set for the call

ConfirmSoundstring

Remote URL to fetch with POST HTTP request which must return a RestXML with Play, Wait and/or Speak Elements only (all others are ignored). This RESTXML is played to the called party when he answered

ConfirmKeystring

DTMF tone the called party must send to accept 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)

Example request

{
  "Delimiter": "<",
  "From": "15551234567",
  "To": "15557654321",
  "Gateways": "user/,sofia/gateway/PSTNgateway1/,sofia/gateway/PSTNgateway2/",
  "AnswerUrl": "https://example.com/answer/",
  "RejectCauses": "USER_BUSY,NO_ANSWER",
  "CallerName": "Bulk Test",
  "ConfirmSound": "https://example.com/confirm_sound/",
  "ConfirmKey": "1",
  "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": "2e8e6275-7cfe-4e3c-a8d6-25316b4519c7"
}

Response

Response message

RequestUUIDstring[] required

Unique identifiers of each 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": "BulkCalls Request Executed",
  "RequestUUID": [
    "fc92f3f4-3777-43ed-b269-5b4a0d474b12",
    "22f94a34-2890-4f18-ab99-5c47e25dd3c3",
    "d1337342-0225-465d-b7bb-1b5d88eb39d2"
  ],
  "Success": true,
  "RestApiServer": "localhost"
}

Changes

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