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

post

API call for signing in a new account.

Authorizations

Body

emailstringRequired

Registered email

Example: [e-mail]

passwordstringRequired

Registered password

Example: Something23!

Responses

200

Sign-in Successfull

application/json

post

HTTPcURLJavaScriptPython

POST /api/users/signin HTTP/1.1
Host: www.channel360.co.za
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "email": "[e-mail]",
  "password": "Something23!"
}

200

Sign-in Successfull

{
  "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

post

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

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

200Success

post

HTTPcURLJavaScriptPython

POST /api/AgentLogon HTTP/1.1
Host: agentchat.abcsoftware.dnsalias.com
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "EmailAddress": "[e-mail]",
  "Password": "123smith$$"
}

200Success

No content