Call a number from the keypad (F10.5a)
POST/api/calls/dial
Place an outbound call with NO conversation to start from — the call-centre dialler, where an agent types a number.
It shares the origination path of
POST /api/conversations/{id}/call/start exactly, and differs only in
how it finds the line and the person. A second origination path would be
a second set of answers to "may this channel dial", "whose consent
regime applies" and "what happens to the media leg when the provider
refuses" — and the copy that drifts leniently is the one that places a
call it should not have.
THE NUMBER MUST CARRY ITS COUNTRY. A bare national number is refused
(422 number_not_international) rather than guessed at: guessing is how
0532… becomes a call to whoever holds that number wherever the server
assumed, and nothing downstream un-rings that phone.
AN EXISTING THREAD IS A REFUSAL, NOT AN ADOPTION. Origination reuses the contact's open thread on this channel; when such a thread exists and the actor could not have replied to it, this 403s rather than letting an agent reach into a colleague's conversation by dialling the customer's number.
The response's voice_conversation_id is the thread the call landed in
— on a phone line a fresh voice one, since a telephone has no written
thread behind it.
Request
Responses
- 201
- 401
- 403
- 404
- 422
The call is being placed.
Not authenticated. code: account_disabled means the member's seat was deactivated in this workspace: the session is over even though the token was not revoked (clients sign out and clean up).
No permission to reply, no access to this line, or a live thread on it the actor could not have replied to.
No such channel or contact.
number_not_international — the number carries no country code; no_call_permission — the customer has not allowed calls on a channel that imposes a consent regime; or the line cannot dial.