api/v1/sims/{id}/sendsms

Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/sims/{id}/sendsms

Summary

Send an SMS message to a SIM

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the SIM to which an SMS message will be sent

 globally unique identifier

Required

Body Parameters

SMSModel contains details of the SMS body

SMSModel
NameDescriptionTypeAdditional information
Body

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Body": "sample string 1"
}

application/xml, text/xml

Sample: 
<SMSModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.SIMs">
  <Body>sample string 1</Body>
</SMSModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SMSModel'.

Response Information

Resource Description

A success message if the SMS was sent successfully

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.