testing

Place a real test call from this agent to a phone number

post/api/v1/agents/{id}/test-call

Request

  • Base URL: https://www.callagent.pro
  • URL: https://www.callagent.pro/api/v1/agents/{id}/test-call
  • Auth: HTTP bearer

Path parameters

idinteger required

Request body

phone_numberstring required

Dialable number; digits with an optional leading +

from_numberstring nullable

Caller ID to present; the provider decides whether to honour it

contextstring nullable

Briefing for THIS call only, appended to the agent prompt

Response

The call was handed to the dialler. This returns as soon as dialling STARTS; it does not wait for an answer. Poll GET /live while it runs, then GET /calls/{id} once it has ended.

okboolean
dataobject

Dialler acknowledgement. Contents come from the telephony backend and are not fixed; treat any field as optional and do not depend on one being present.

Changes

No recorded changes to this operation across all 1 revision of this API.