SMS API: Difference between revisions

From Planfix
Jump to: navigation, search
No edit summary
No edit summary
Line 29: Line 29:


The request is sent using a POST method in the format application/x-www-form-urlencoded, to the address specified in the integration settings.
The request is sent using a POST method in the format application/x-www-form-urlencoded, to the address specified in the integration settings.
===API call parameters===





Revision as of 07:01, 3 February 2022

API Overview

This API is intended for owners of services that send SMS messages. It allows you to connect your SMS service to Planfix if it's not in the list of available services for integration, thus enabling you to send SMS messages from Planfix through your service.

After setting up this integration, you can contact our Support Team to see about getting your service added to the list of integrations available to users in the Planfix interface. The exchange happens over HTTPS. Planfix sends requests to the service address specified in the integration settings.


Connecting in the Planfix interface

To connect and configure the integration, go to the section Account management / Integrations / Integrations with SMS services

In this section, go to the bottom of the list and select Planfix API (using username and password) or Planfix API (using key), depending on the method you wish to use to authorize requests in your service.


L2hLtn.png


A window will open with integration settings.


XefZPg.png


Here, you will specify the address to which Planfix will send requests; the client's username and password; and the SMS sender name (when authorizing using a key, you'll enter the API key instead of the username and password)


API call format for sending SMS when using username and password

The request is sent using a POST method in the format application/x-www-form-urlencoded, to the address specified in the integration settings.


API call parameters

Go To