API

API Accesses

The API Accesses interface serves to generate API keys to enable interconnection with third-party systems for example, for message sending.

1. The table contains the following parameters:

  • ID: the System identifier.
  • Name: The name of access permission. Under this name you will be able to see the statistics on
    sending codes in reports.
  • API key: is a code used to identify an application or user and is used for
    authentication in computer applications.
  • Scopes: Avalable acess scopes. Possible values are Recipients, Broadcasts, CRM, omni-api.
  • Webhook: URL to which statuses and response messages will be sent.
  • Actions: Hover over the record to view the controls.

2. Click the pencil/Edit icon to edit the record or trash/Delete icon to delete the record.
3. Click to apply sorting.
4. Click to add filter.
5. Click Create API access to generate a new API key.

API Key Generation

  1. Name: enter the API key name to be displayed in the table.
  2. Webhook: provide a URL to which statuses and responses to messages will be sent.
  3. Select Scopes.
  4. Select Senders.
  5. Click Create API key to generate a key. The key will appear in the window as shown on the right.
  6. Click Cancel to discard changes.

Other Resources

STOP Keyword Configuration

Sender ID Registration Form