Get WhatsApp SMS Configuration

The Get WhatsApp SMS Configuration API returns the current WhatsApp SMS configuration details.

URL

The HTTP URL for the Get WhatsApp SMS Config API is:

http://<<host>>:<<port>>/api/v1/whatsappconfig

This service implements Gateway Filter for Authentication to authenticate access of the service by a user.

Method

GET

Output Parameters

The following fields are output parameters:

TWILIO

Output Parameter	Level-Two	Type	Description
protocol		string	A protocol about a standard method used at each end of a communication channel. You must use a mail client to access a mail server. The mail client and mail server can exchange information with each other using protocols. HTTP is the standard input for this field.
provider		string	WhatsApp SMS service provider, for example: TWILIO_WHATSAPP
properties			An array of WhatsApp SMS provider properties
	key - value pair (user authentication)	NA	The key value pair for user authentication. For Twilio, it is account SID and auth token.
	key - value pair (From)	NA	The WhatsApp number or client identifier that initiated the call.
	key - value pair (host URL)	URL	Twilio provider, the Host URL is set.
	key - value pair (Header Content Type)	string	This field is set with the header content type as application/xwww- formurlencoded. The application/xwww- formurlencoded is the contenttype headers for HTTP POST requests that browsers must support. This request sends a list of name/value pairs to the server
	key - value pair (Maximum Character Limit)	long	Maximum number of characters allowed in an WhatsApp message

Sample Response

TWILIO

{
  "protocol" : "HTTP",
  "inboundSecurityEnabled" : false,
  "provider" : "TWILIO_WHATSAPP",
  "properties" : [ {
    "key" : "Account SID",
    "value" : "xxxxx"
  }, {
    "key" : "Auth Token",
    "value" : "xxxxx"
  }, {
    "key" : "From",
    "value" : "xxxxx"
  }, {
    "key" : "Host URL",
    "value" : "https://api.twilio.com/2010-04-01/Accounts/##AccountSid##/Messages.json"
  }, {
    "key" : "Header Content Type",
    "value" : "application/x-www-form-urlencoded"
  }, {
    "key" : "Maximum Character Limit",
    "value" : "140"
  } ]
}

Response Status

Code	Description
Status 200	Successfully shows the SMS config details
Status 400	Invalid request format
Status 401	Unauthorized request
Status 500	Server failure to process request