Get Channel

Overview

Use this API to Get channel detail information in the Conversation Manager.

Scope

Client application must have 'app.conversation.conversationmgr.manage' or 'app.conversation.conversationmgr.read' scope assigned.

SecurityoAuthClient

Request

path Parameters

required

string = 36 characters

id of object

Example: 7b6c5fff-036e-4a40-b68a-a67c592fc079

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/channels/{id}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"id": "6121306b-59c2-4a2c-afee-1e025a84b0d9",
"type": "custom_channel",
"icon": "<base64>",
"displayName": "Custom Channel",
"description": "Custom Channel",
"active": true,
"created": "2021-06-11T21:14:41.836Z",
"modified": "2021-06-11T23:14:41.836Z",
"restrictions": {"inbound": {"maxTextLength": 140,
"features": ["typing_events",
"attachments",
"richText"
],
"attachmentPolicy": {"enabled": true,
"maxSize": 12345,
"type": "block",
"extensions": ["bat",
"exe"
]
}
},
"outbound": {"maxTextLength": 140,
"systemMessages": true,
"midChatAuth": true,
"features": ["typing_events",
"attachments",
"richText"
],
"richMessageTypes": ["listpicker",
"timepicker",
"richlink"
],
"attachmentPolicy": {"enabled": true,
"maxSize": 12345,
"type": "block",
"extensions": ["bat",
"exe"
]
}
}
},
"l10nProperties": [{"language": "en-US",
"properties": [{"name": "msg_hub_retain_and_retry",
"value": "Thank you for reaching out. We will respond to you at the earliest."
},
{"name": "msg_hub_off_hours",
"value": "Thank you for your inquiry. Our service hours are 9am-5pm PST, Monday-Friday. If you are trying within the service hours and still getting this message, please try again after some time."
},
{"name": "msg_hub_invalid_content_type_to_customer",
"value": "This content type is not currently supported."
},
{"name": "msg_hub_invalid_content_type_to_agent",
"value": "This content type is not currently supported."
},
{"name": "msg_hub_channel_msg_failed",
"value": "Message could not be delivered. Please try again after some time."
},
{"name": "msg_hub_blocked_file_extension",
"value": "Attachment file type '{0}' is not allowed."
},
{"name": "msg_hub_attachment_size_exceeds_limit",
"value": "File could not be sent. It exceeded the maximum limit of {0}"
}
]
}
]
}