post https://api.talkdeskapp.com/apps//installations//channels
Scope
apps:write
Request Body
{
"type": "messages",
"resource_type": "number",
"resource": "string"
}
Body Response - Schema
200 (channel provisioned for the app installation)
| Parameter | Type | Description |
|---|---|---|
| total | integer | n/a |
| page | integer | n/a |
| per_page | integer | n/a |
| _embedded | object | "_embedded" subdivides into: 1.1 - "users" (array[object]), which subdivides into: 1.1.1 - "type" (string) - the type of channel. Allowed value: "messages". 1.1.2 - "updated_at" (string) - date of the latest change to this channel. 1.1.3 - "_embedded" (object), which subdivides into: 1.1.3.1 - "resource" (array[object]), which subdivides into: 1.1.3.1.1 - "id" (string) - the ID of the target resource. 1.1.3.1.2 - "type" (string) - the target resource type (e.g.: "number"). 1.1.4 - "_links" (object), which subdivides into: 1.1.4.1 - "self" (object), which subdivides into: 1.1.4.1.1 - "href" (string) -default: http://api-docs.talkdesk.org/numbers/{number_id}/channels/{type} |
| _links | object | "_links" subdivides into: "self" (array[object]), which subdivides into: "href" (string) -default: https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/channels |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (app or installation not found), 409 (resource already in use)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have questions or technical issues, please open a ticket using this form.