Quick Start

Good to know: Channel Mobile offers two different APIs 1. Channel360 API. 2. AgentChat API.

Get your API keys

Currently we offer token based authentication for our Broadcasting and Conversation.

You make a Sign In Request, which will return a token, which you can use to make additional authorised calls.

The best way to interact with our API is to use one of our official libraries:

Get Channel360 API Token

To get the API Token, send a Sign-In request to our new Channel360 Cloud API.

Sign-In

API call for signing in a new account.

post

/api/users/signin

Authorizations

Body

emailstringrequired

Registered email

Example: [e-mail]

passwordstringrequired

Registered password

Example: Something23!

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://www.channel360.co.za/api/users/signin' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "password": "Something23!"
  }'

200

200

{
  "user": {
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe",
    "username": "JohnDoe",
    "version": 0,
    "id": "631082680d5cc30019ff02b0"
  },
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYzMDg4MWUwNTA4ZjIwMDAxYzA3NDU1OSIsImVtYWlsIjoiam9obkBkb2UuY29tIiwiaWF0IjoxNjYyMDM5NjIwfQ.ehFb0N29xnJbScuMOTgoW4QlYgIqZlHLPj8nqy9oXGE"
}

Sign-in Successfull

For our conversation's API, please contact our sales team if you want an instance of our AgentChat/Conversation API mailto:[e-mail]

Get Session Token for AgentChat API

For our V1 AgentChat API, you will need to make a Sign-In request to your dedicated instance

AgentLogon

The API call to logon the agent and return a session token

post

/AgentLogon

Query parameters

Versionstringrequired

The current version number

Example: {{BUILD_VERSION}}

Body

EmailAddressstringrequired

The unique email address and the username the agent will use to login

Passwordstringrequired

The password corresponding to the unique email address

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://agentchat.abcsoftware.dnsalias.com/api/AgentLogon?Version=%7B%7BBUILD_VERSION%7D%7D' \
  --header 'Content-Type: application/json' \
  --data '{
    "EmailAddress": "[e-mail]",
    "Password": "123smith$$"
  }'

200

200

No body