fbpx

API Reference Docs

Send notification to users through API:

NOTE: In case of a new user (i.e. the user doesn’t exist on your contact list in AiSensy Platform) then a new contact will get created with the incoming details.

HTTP Request

#

POST https://backend.aisensy.com/campaign/t1/api

Request Body
#

The request body contains data with the following structure:

JSON Representation #

{
  apiKey: string,
  campaignName: string,
  destination: string,
  userName: string,
  source: string,
  media: {
    url: string,
    filename: string
  },
  templateParams: [
    string
  ],
  tags: [
    string
  ],
  attributes: {
   attribute_1: string
  }
}

FieldsDescription
apiKeystring

Required. API key generated from the dashboard.
campaignNamestring

Required. Name of the campaign which has to be sent to the user. The status of the campaign should be ‘Live’.
destinationstring

Required. Mobile number of users with country dial-code to whom the campaign has to be sent.
e.g. – +917428526285 (India)
It’s recommended to provide it in +(country code)(phone number) format. If a phone number can’t be resolved to any country then, it is by default considered to be from India(+91).
userNamestring

Required Name of the user to whom campaign has to be sent.
sourcestring

Optional. Source of lead. It is to create a source-based segment to re-target.
e.g.- ‘Facebook forms’, ‘Website lead’, ‘Youtube lead’
mediaobject

Optional. URL & filename of media that has to be sent with the template message.
templateParams[]string

Optional. An array of parameter values to fill in a template message
tags[]string

Optional. An array of tag names to assign to the user.
attributesobject with key-value pairs. The only string is allowed as the key’s value.

Optional. The object should contain keys already added as assistant attributes paired with values that you want to set as user’s attributes.

NOTES:

  • optional fields are not necessary for the request payload
  • The medial URL provided in the media object should be publically accessible, otherwise, the request will be rejected
  • The length of the template params array should be equal to the number of params required in the campaign whose name is provided in campaignName field. Otherwise, the request will be rejected
  • Tags should be created in your project before using them. It can be done by anyone with manager level access
  • If a tag doesn’t exist in your project, it will be ignored
  • Attributes should be added to the project before using them. It can be done by anyone with manager level access
  • If an attribute doesn’t exist in your project, it will be ignored

Response Body #

If successful, the response body will return a status of 200.