SEsentdm
Voice

Add a participant to a call

Changed on

Dials one of your app users or a phone number into a call that is in a conference room, and answers with the participant's own call record. The participant is a call of their own: it has its own id, can be looked up and hung up, and is billed and reported through call.completed and call.failed like any other call. Every participant needs a positive balance. A phone participant is called from caller_id, which must be one of your numbers, or from the call's owning number when omitted, and needs a destination you may call. Only a call your answer connected to a conference can take participants: a call connected to a user or a number answers 409.

post/v3/voice/calls/{id}/participants

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/voice/calls/{id}/participants
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring required

The call id from the route, as carried by call webhooks and the calls list, for example call_9f2ab000-0000-4000-8000-000000000001

Headers

Idempotency-Keystring

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

caller_idstring nullable

The number shown to a phone participant as the caller, in E.164 format. Must be one of your numbers. The call's owning number when omitted

Example request

{
  "to": {
    "kind": "number",
    "value": "+14155551234"
  },
  "caller_id": "+12025550123",
  "sandbox": false
}

Response

The participant is being dialed; the body is their call record

successboolean

Indicates whether the request was successful

Changes

  • 41acb2ceb84dRevision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 1a451bbb5736Revision changes
    • info

      endpoint added