Test channel connectivity
POST /api/channels/{channelId}/test
POST
/api/channels/{channelId}/test
Verify that the channel can send and receive messages. For email channels this sends a test message; for WhatsApp and voice channels this validates the API credentials against the provider.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” channelId
required
string format: uuid
The unique identifier of the channel to test.
Responses
Section titled “ Responses ”The test completed. Check the ‘ok’ field for the result.
Simple success acknowledgment returned by action endpoints (reply, resolve, take-over, etc.).
object
ok
required
Always true on success.
boolean
Example
trueNo channel exists with the given ID in the authenticated tenant.
Standard error response returned by all endpoints on failure.
object
error
required
A human-readable error message describing what went wrong.
string
Example
Conversation not found