SMS CAMPAIGNS API

NotifyVisitors API endpoints enable you to send SMS campaigns to the users to make them aware of your brand so that they subscribe to your services and can turn into loyal customers. You can send the SMS campaigns to a specific user, to all the users, or to a specific segment.

Call on the below API to send SMS campaigns to the users

https://mail.notifyvisitors.com/api/v1/sms/broadcast/

API ENDPOINTS FOR DIFFERENT SEGMENTS :

To a specific user

  • You can send SMS campaigns to the specific users on the basis of their phone numbers via the below API endpoint.
https://mail.notifyvisitors.com/api/v1/sendMessage

You have to send the post parameters such as SMS campaign or user ID to an API endpoint.

To all the users

  • Call the below API endpoints to send SMS campaigns to all the users
https://mail.notifyvisitors.com/api/v1/sms/broadcast/all

Sender name, campaign name, and segment id are the post parameters that you have to send as the post parameters to the API endpoint.

To a specific segment

  • Call the below API endpoints to send SMS campaigns to the users of a specific segment.
https://mail.notifyvisitors.com/api/v1/sms/broadcast/segment

Campaign name, sender mobile, and sender name are the post parameters that you have to send as the post parameters to the API endpoint.

API RATE LIMIT

  • The API rate limit is the number of times the API can be requested per minute.
  • You can make up to 500 API requests per minute on an API.
  • If the limit exceeds, the app will throw an error in Response. All API requests are subject to rate
    limits.

PASS THE SMS VARIABLES AS PARAMETERS IN THE REQUEST BODY

See the below example

curl --request POST \
  --url https://mail.notifyvisitors.com/api/v1/sendMessage
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-api-key: 078F9614571CE78626C6C68D2E89A5CA' \
  --header 'x-brand-id:8127'\
  --data '{"sender_name":"John Doe",
   “Sender_mobile”: “7786547894”,
  "service provider_id":3456,
  "campaign_name":" marketing campaign",
  "schedule time":"15:15”,
  "url":"https://www.notifyvisitors.com/"
    }'

PARAMETERS

TYPE

DESCRIPTION

MANDATORY

sender_name

string

Name of the sender

Yes

campaign_name

string

Name of the campaign

Yes

sender_mobile

string

Mobile number of the sender

Yes

message

string

Content of the sms campaign

Yes

serviceproviderID

integer

Id of the service provider

Yes

segment_id

integer

Unique id of the segment in which the user falls

Yes

schedule_date

integer

Scheduled date for the sms campaign

Yes

schedule_time

integer

Schedule time for the sms campaign

Yes

frequency_capping

Boolean

No. of times sms shall be send to the users per day or per week

No

dnd

Boolean

Do not disturb setting- when the sms campaigns shall not be send to the users

No