For more information on using API

GET https://webapi.mymarketing.co.il/api/smscampaign/OperationalMessage/{id}

Get SMS message by id

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Operational SMS id. Can be found in the UI (go to Mobile -> SMS -> SMS list -> filter table by 'Transactional SMS' -> inspect/F12)

integer

Required

Body Parameters

None.

Response Information

Resource Description

ApiSmsCampaignInfo

Name

Description

Type

Additional information

id

SMS campaign id

integer
name

Operational campaign name. Internal use only.

string

Required

from_name

From name. Required if "sms_sending_profile_id" is not used. The sender name. The name must be up to 11 English letters without special characters or spaces.

string
sms_sending_profile_id

SMS sending profile ID. Required if "from_name" is not used. Can be found using the endpoint "Get account's sms campaigns.." or in the UI (go to Mobile -> SMS -> SMS list -> inspect/F12)

integer
content

SMS content.

string

Required

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "from_name": "sample string 3",
  "sms_sending_profile_id": 4,
  "content": "sample string 5"
}

application/xml, text/xml

Sample:
<ApiSmsCampaignInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport">
  <content>sample string 5</content>
  <from_name>sample string 3</from_name>
  <name>sample string 2</name>
  <sms_sending_profile_id>4</sms_sending_profile_id>
</ApiSmsCampaignInfo>