POST api/Common/sendMobileMessage?businessid={businessid}&userid={userid}&purpose={purpose}

Request Information

URI Parameters

Name	Type	Additional information
businessid	integer	Default value is 0
userid	integer	Default value is 0
purpose	string	Default value is Clevertap

Body Parameters

SendSmsRequestModel

Name	Type	Additional information
message	string	None.
phone	string	None.
flag	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "phone": "sample string 2",
  "flag": 3
}

application/xml, text/xml

Sample:

<SendSmsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <flag>3</flag>
  <message>sample string 1</message>
  <phone>sample string 2</phone>
</SendSmsRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2024/09/19 17:24:32",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>