Dialplan_History
GET /dialplans[/:dialplans_id]/dialplan_history
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| dialplan_id | Dialplan's identifier |
NO | |
| dialplan | JSON | Dialplan's old version |
NO |
| date | date | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /dialplans[/:dialplans_id]/dialplan_history[/:dialplan_history_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| dialplan_id | Dialplan's identifier |
NO | |
| dialplan | JSON | Dialplan's old version |
NO |
| date | date | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /dialplans[/:dialplans_id]/dialplan_history[/:dialplan_history_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| dialplan_id | Dialplan's identifier |
NO | |
| dialplan | JSON | Dialplan's old version |
NO |
| date | date | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
POST /dialplans[/:dialplans_id]/dialplan_history[/:dialplan_history_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| dialplan_id | Dialplan's identifier |
NO | |
| dialplan | JSON | Dialplan's old version |
NO |
| date | date | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.telephonie.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Dialplans
GET /dialplans
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | Dialplan's identifier |
NO | |
| dialplan | JSON | Dialplan in JSON |
YES |
| files | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /dialplans
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | Dialplan's identifier |
NO | |
| dialplan | JSON | Dialplan in JSON |
YES |
| files | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.telephonie.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /dialplans[/:dialplans_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | Dialplan's identifier |
NO | |
| dialplan | JSON | Dialplan in JSON |
YES |
| files | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /dialplans[/:dialplans_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | Dialplan's identifier |
NO | |
| dialplan | JSON | Dialplan in JSON |
YES |
| files | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.telephonie.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /dialplans[/:dialplans_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | Dialplan's identifier |
NO | |
| dialplan | JSON | Dialplan in JSON |
YES |
| files | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.telephonie.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /dialplans[/:dialplans_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | Dialplan's identifier |
NO | |
| dialplan | JSON | Dialplan in JSON |
YES |
| files | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Numbers
GET /numbers
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| settings | NO | ||
| name | Number's name |
NO | |
| type | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /numbers
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| settings | NO | ||
| name | Number's name |
NO | |
| type | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.telephonie.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /numbers[/:number]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| settings | NO | ||
| name | Number's name |
NO | |
| type | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /numbers[/:number]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| settings | NO | ||
| name | Number's name |
NO | |
| type | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.telephonie.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /numbers[/:number]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| settings | NO | ||
| name | Number's name |
NO | |
| type | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.telephonie.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /numbers[/:number]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| settings | NO | ||
| name | Number's name |
NO | |
| type | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.telephonie.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |