For more information on using API

GET https://webapi.mymarketing.co.il/api/automations/{id}/SMSCampaignSteps/{stepId}

Get the information of a specific SMS step in the given automation

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id int the URL)

integer

Required

stepId

Step id. Can be found using the endpoint "Get all the 'send SMS' steps in a given automation" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id int the URL)

integer

Required

Body Parameters

None.

Response Information

Resource Description

ApiAutomationSmsStepInfo

Name

Description

Type

Additional information

campaign_name

Campaign name

string

Required

user_sms_profile_id

User Sms Profile Id

integer

Required

from_name

From name

string

Required

content

Message content

string

Required

is_link_tracking

If the links are tracked

boolean
unsubscribe_text

Unsbscribe test to add to link

string
id

Step id

integer
type

Step type from list

TypesAutomationStepTypes
object_id

Sms campaign id

integer
working_days

A list of the working days for the step

Collection of ApiAutomationExtendedDetailsWorkingDays

Response Formats

application/json, text/json

Sample: 
{
  "campaign_name": "sample string 1",
  "user_sms_profile_id": 2,
  "from_name": "sample string 3",
  "content": "sample string 4",
  "is_link_tracking": true,
  "unsubscribe_text": "sample string 6",
  "id": 1,
  "type": "EmailCampaign",
  "object_id": 1,
  "working_days": [
    {
      "day": 1,
      "from": "00:00:00.1234567",
      "to": "00:00:00.1234567"
    },
    {
      "day": 1,
      "from": "00:00:00.1234567",
      "to": "00:00:00.1234567"
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiAutomationSmsStepInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <campaign_name>sample string 1</campaign_name>
  <content>sample string 4</content>
  <from_name>sample string 3</from_name>
  <id>1</id>
  <is_link_tracking>true</is_link_tracking>
  <object_id>1</object_id>
  <type>EmailCampaign</type>
  <unsubscribe_text>sample string 6</unsubscribe_text>
  <user_sms_profile_id>2</user_sms_profile_id>
  <working_days>
    <ApiAutomationExtendedDetailsWorkingDays>
      <day>1</day>
      <from>PT0.1234567S</from>
      <to>PT0.1234567S</to>
    </ApiAutomationExtendedDetailsWorkingDays>
    <ApiAutomationExtendedDetailsWorkingDays>
      <day>1</day>
      <from>PT0.1234567S</from>
      <to>PT0.1234567S</to>
    </ApiAutomationExtendedDetailsWorkingDays>
  </working_days>
</ApiAutomationSmsStepInfo>