Managing Agents Using SmartCommunicatorâ„¢ APIs

With IntelePeer SmartCommunicator APIs, you can manage your agents: view agents collectively or individually, onboard or offboard agents, and update current agents.

Base URL

All of the following endpoints share the same base URL:

atmosphere-api.intelepeer.com

Example

GET https://atmosphere-api.intelepeer.com/rest/v1/smartcomm/{customer_id}/agents

Prerequisites

Prior to working with the SmartCommunicator APIs, make sure the following are in place:

  • SmartCommunicator is enabled for the account

  • Messaging is enabled for SMS/MMS

  • The numbers have been 10DLC registered

  • All telephone numbers (TNs) are in the SComm database

  • All TNs have two-factor verification (2FV) in the SComm database

  • Your users have API Access set up up for their

Authorization

Important: To authenticate, you must first have API Access set up for your username and password. For more information, check out API Authentication. This topic includes how to set up new users with API access. If you are using Postman to send your API requests, make sure to add the following Keys in the Headers section: Content-Type: application/json and Accept: application/json. Check out the Sample for details.

The POST API takes a body consisting of username and password and makes an Authenticate API call to voice services:

POST https://atmosphere-api.intelepeer.com/rest/v1/authenticate

The response returns a 200 response with a token or 401 Unauthorized. If you are unauthorized, you receive an error message.

If you receive a 200 response, the encoded JSON Web Token (JWT) contains the eID, expirationTime, productID, and username.

JWT Payload Example
{   
    "username": "someone@yourmail.com",
    "password": "enter_password_here"
}
Token Example
eyJhbGciOiJSUzI1NiJ9.eyJhaWQiOjAsImNpZCI6MSwiY3J0IjoxNzExOTg2NDg5LCJleHAiOjE3MTIwNzI4OTAsInVpZCI6InNiZWRveWEiLCJzcmMiOiJhcGktZ3R3In0.clYxxuFBW62FQj-nQLIjtE4HBG1iPKjlWsTfLlEqo_u6UN4D6u9Mk26LXsTYUgsTzZ6-wHCWOctYghh0VfQVpA}
Sample

The following sample shows the header setup for authentication using Postman. In this case, both the Accept and Content-Type values must be set to application/json.

SmartCommunicator APIs

Click the following API titles to view the parameters and code samples associated with each endpoint.