Place a Call (click-to-call)

post

https://api.lodgestory.com/api/wp-crm/voice/{organisationId}/calls

Ring an agent and bridge to a customer. Place the call AS a chosen agentUserId (must have a calling number — see GET /agents).

Subject to the per-org daily/monthly call cap and the destination prefix allowlist. Requires the voice API enabled + CRM_ADMIN/ACCOUNT_OWNER/CRM_BOT.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organisationId

string

required

Your organisation UUID (returned as org from the /token endpoint).

Body Params

agentUserId

string

required

The agent to place the call AS. Must be a user in your organisation that has a calling agent number configured (see GET /agents → hasAgentNumber=true).

destinationNumber

string

required

The customer number to dial, E.164 (a leading + is added if missing).

callingAccountId

string

Which calling account to use. Optional — defaults to your single active voice account; required only if you have more than one (see GET /accounts).

callingNumberId

string

Caller-ID DID to present (see GET /numbers). Defaults to the agent/account default.

wpCrmChatsId

string

Optional chat to link this call to (for the conversation timeline).

callTimeout

number

Ring timeout in seconds (10-120). Defaults to the system value.

Responses

400

Bad request — agent not call-enabled, or destination not allowed

401

Unauthorized

403

Forbidden — role not permitted or voice API not enabled

429

Too many requests / call cap reached

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Call initiated