AdminExtensions
Create Extension/Agent
Create new extension/agent for call handling
Details
| Description | The "Create Extension" Endpoint enables you to establish a new extension/agent. |
|---|---|
| HTTP Method | POST |
| Endpoint URL | https://platform.innocalls.com/api/v1/api-gateway/extesnion |
| Authorization | To access the API endpoints, you need to authenticate using API keys and API secrets. The API supports Basic Authentication for authorization. You need to include your API ID as the username and your API secret as the password in the HTTP header when making requests. Replace API_ID with your API ID and API_SECRET with your API secret, separated by a colon (:). The value after Basic is the Base64 encoding of your API key and API secret concatenated with a colon. |
| Rate Limit | 3 requests per second |
Request Parameters
| Parameter | Description | Constrains |
|---|---|---|
| Extension's Email | Required | |
| name | Extension's name | Required |
| ext | Extension's number | Required |
| pin | Extension's pin | Required |
| inbound | Enable inbound for the current extension or not | Required Allowed values 0 Or 1 |
| outbound | Enable outbound for the current extension or not | Required Allowed values 0 Or 1 |
| voicemail | Enable voicemail for the current extension or not | Required Allowed values 0 Or 1 |
| canListenToRecords | Detect if the agent can listen to records in our dashboard or not | Optional
|
Request Example
curl 'https://platform.innocalls.com/api/v1/api-gateway/extension' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <base64-encoded string apiId:apiSecret>' \
--data-raw '{
"email": "agentEmail@innocalls.com",
"name": "AgentName",
"ext": 0,
"inbound": 0,
"outbound": 0,
"voicemail": 0,
"pin": "1234",
"canListenToRecords":false
}'Success Response Example
A successful response is indicated by the HTTP status code 202.
Possible Errors
| Error Code | Description |
|---|---|
| 401 Unauthorized | Invalid Credential |
| 403 Forbidden | Not Enough Permissions to access the resource |
| 400 BadRequest | This error occurs due to malformed or invalid request parameters |
| 429 Too Many Requests | This occurs when requests exceed the rate limit |
| 409 Conflict | The email or extension number already exists |
