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.

POSThttps://www.channel360.co.za/api/users/signin

Authorization

bearerAuth

Body

application/json

Sign-in Details

email*string

Registered email

Example: "[e-mail]"

password*string

Registered password

Example: "Something23!"

Response

200

Sign-in Successfull

Body

application/json

userobject

tokenstring

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYzMDg4MWUwNTA4ZjIwMDAxYzA3NDU1OSIsImVtYWlsIjoiam9obkBkb2UuY29tIiwiaWF0IjoxNjYyMDM5NjIwfQ.ehFb0N29xnJbScuMOTgoW4QlYgIqZlHLPj8nqy9oXGE"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://www.channel360.co.za/api/users/signin', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]",
      "password": "Something23!"
    }),
});
const data = await response.json();

Response

200

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

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

POSThttps://agentchat.abcsoftware.dnsalias.com/api/AgentLogon

Query parameters

Body

application/json

EmailAddress*string

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

Password*string

The password corresponding to the unique email address

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://agentchat.abcsoftware.dnsalias.com/api/AgentLogon?Version=%7B%7BBUILD_VERSION%7D%7D', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "EmailAddress": "[e-mail]",
      "Password": "123smith$$"
    }),
});
const data = await response.json();