This endpoint identifies the caller as a specific signed-in agent, so it only works with a
user session token (from
POST /auth/login), not a workspace API key — see
Authentication. A workspace API key has no agent identity
behind it and gets 403 Forbidden.Before you start
- The signed-in user needs their own SIP extension — every invited user gets one automatically, see Invite users.
Steps
1
Send the request
destination is required, in E.164 format. caller_id is optional — omit it to use your
workspace’s default active outbound number.2
Read the response
202 Accepted means the call was queued for origination — not that it has connected
yet.Verify
The requesting agent’s phone rings first; once they answer, Get2Dial dials the destination
and bridges the two legs. Track the call’s progress with the
call.originated,
call.answered, and call.bridged webhook events.Common problems
- 403 with “no agent identity for this session.” You authenticated with a workspace API key. Use a user session token instead — see the note above.
- 400 “your account has no SIP extension provisioned.” The signed-in user has no SIP extension. See Invite users.
- 503 “no edge currently available.” No infrastructure is currently able to place the call. Retry, or contact support if it persists.