Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Channel address

A channel reaches the outside through its addresses: an INBOUND address is where messages arrive, an OUTBOUND address is where they are sent from. A channel holds at most one of each.

An outbound address may only be used once the tenant has proven that it owns it.

Give a channel an address

post

Gives a channel an address. direction is INBOUND for the address messages arrive at and OUTBOUND for the one they are sent from; type is EMAIL, PHONE, TOKEN or URL, and value is the address itself.

An outbound address that is not a URL may only be used once the tenant has proven that it owns it: without a verified claim on that address the request is answered with 403. Inbound addresses carry no such requirement.

A channel holds at most one identity per direction — adding a second one for the same direction replaces it. The answer is the channel, so the caller sees the result in one step.

Authorizations
AuthorizationstringRequired

Token issued by the central equipme authentication, sent as Bearer <token>.

Path parameters
channelIdintegerRequired

Channel id

Example: 3
Body
objectOptional
or
Responses
200

OK

application/json
post/v1/channels/{channelId}/identities
POST /api/v1/channels/{channelId}/identities HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "data": {
    "active": true,
    "createdAt": "text",
    "id": 1,
    "kind": "",
    "name": "text",
    "purpose": "",
    "tenant": {
      "id": 1,
      "name": "text"
    },
    "tenantId": 1,
    "updatedAt": "text"
  }
}

Take an address away from a channel

delete

Takes an address away from a channel. The direction in the path says which one — INBOUND or OUTBOUND. The answer is the channel without that identity.

A channel without an inbound identity receives nothing; without an outbound one it cannot send.

Authorizations
AuthorizationstringRequired

Token issued by the central equipme authentication, sent as Bearer <token>.

Path parameters
channelIdintegerRequired

Channel id

Example: 3
directionstringRequired

INBOUND or OUTBOUND

Example: OUTBOUND
Responses
200

OK

application/json
delete/v1/channels/{channelId}/identities/{direction}
DELETE /api/v1/channels/{channelId}/identities/{direction} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "active": true,
    "createdAt": "text",
    "id": 1,
    "kind": "",
    "name": "text",
    "purpose": "",
    "tenant": {
      "id": 1,
      "name": "text"
    },
    "tenantId": 1,
    "updatedAt": "text"
  }
}

Last updated

Was this helpful?