Trigger an outbound call

Place a single outbound call from one of your DIDs to a customer number.

POSThttps://nextgenpanelstaging.cloudshope.com/api/v1/outboundCallApis/outboundCall

Places one outbound call: from_number (one of your account's DIDs) dials mobile_number. The call is rejected with 404 only when the account's manual-dialer licence has expired and its outgoing-call credit is 0; in other low-credit cases the request is accepted and the telephony side declines the call. A blacklisted mobile_number is logged on the report, not blocked. In the response, data.mobile is the account's server DID, not the customer number.

Numbers must be exactly 10 digits — a 91 prefix is rejected. Optional voice clips (from_clip_id / to_clip_id) play a pre-recorded message to either party before the call connects, and dlurl receives a callback when the call completes.

Errors on this endpoint return { "success": false, "message": "…" } or { "status": …, "message": "…" }, not the standard problem shape.

Authentication

Send Authorization: Bearer <token>. Any valid API token for the account works.

Body parameters

Name	Type	Required	Description
`from_number`	string (10 digits)	Yes	The DID to dial from.
`mobile_number`	string (10 digits)	Yes	The customer number to dial.
`cli_number`	string (10 digits)	No	Caller ID to present, if different from `from_number`.
`max_seconds`	integer	No	Maximum call duration before it is force-ended. Positive integer; defaults to `3600000`.
`billing_source`	integer (1 or 2)	No	Which credit pool to bill the call against. Defaults to `1`.
`from_clip_id`	integer	No	Voice clip id to play to the DID side before bridging. Defaults to `0` (none).
`to_clip_id`	integer	No	Voice clip id to play to the customer side before bridging. Defaults to `0` (none).
`dlurl`	string	No	Callback URL notified when the call completes.

Request

curl -X POST https://nextgenpanelstaging.cloudshope.com/api/v1/outboundCallApis/outboundCall \
  -H "Authorization: Bearer cs_live_9f2c…" \
  -H "Content-Type: application/json" \
  -d '{
    "from_number": "9800000000",
    "mobile_number": "9876543210"
  }'

Response

{
  "status": 200,
  "message": "success",
  "data": { "mobile": "08000000000" }
}

200 — example response

Errors

Status	Type	When
400	`bad-request`	A field failed validation. The body is `{ "status": 400, "message": "Validation failed", "errors": [{ "field", "message" }] }`.
404	`not-found`	`you have no credits left.` (expired manual-dialer licence and zero credit), or the account's user, shard or server could not be found.
500	`internal-error`	Something went wrong placing the call. The body carries `message` or `error`.
401	`unauthorized`	Header missing or malformed, or the token is invalid or expired. The body is `{ "success": false, "message": "…" }`.