Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Input for creating an agent endpoint

agentId
string<uuid>
required

Agent ID to associate this endpoint with

value
string
required

Phone number in E.164 format (e.g., +12345678900)

direction
enum<string>
required

Call direction: INCOMING, OUTGOING, or INCOMING_AND_OUTGOING

Available options:
INCOMING,
OUTGOING,
INCOMING_AND_OUTGOING
environment
string
default:production

Environment name (default: production)

outboundDialType
enum<string>
default:NONE

Outbound dial type: NONE or HTTP_REQUEST (default: NONE)

Available options:
NONE,
HTTP_REQUEST
outboundDialHttpRequestDefinitionId
string<uuid> | null

ID of the HTTP request definition for outbound dialing (required when outboundDialType is HTTP_REQUEST)

Response

The created agent endpoint

data
object
required

Detailed agent endpoint response