api:pbx:app:action:invite
Table of Contents
API : PBX : APP : Action : Invite
Introduction
This request will invite a 3rd party into an existing call.
Request
| URL | https://api.telecomx.dk/pbx/app/action/invite | ||
|---|---|---|---|
| Method | GET | ||
| Access level | PERSONAL, VIEWER, MANAGER, OWNER, RESELLER, ADMIN. | ||
| Query | source | String | Id of call to invite 3rd party to join. |
| target | Id/String | Extension id or phone number to invite. | |
Request example
https://api.telecomx.dk/pbx/app/action/invite?source=pbx4.telecomx.dk:4655455445.44&target=12345678901234567890ABCD https://api.telecomx.dk/pbx/app/action/invite?source=pbx4.telecomx.dk:4655455445.44&target=+4570305050
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ "success": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | source | Invalid source |
| 422 | target | Invalid target |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/app/action/invite.txt · Last modified: 2020/06/19 21:23 by Per Møller