For more information on using API

GET http://webapi.mymarketing.co.il/api/whatsappcampaign/Campaign/{id}

Get WhatsApp campaign by id

Request Information

URI Parameters

Name

Description

Type

Additional information

id

WhatsApp campaign id

string

Required

Body Parameters

None.

Response Information

Resource Description

ApiWhatsAppCampaignInfoCampaign

Name

Description

Type

Additional information

campaign

send_type_name

string
status_name

string
status_date

date
handled_date

date

Response Formats

application/json, text/json

Sample:
{
  "campaign": {
    "id": "5cbc4b86-ce5d-4ee5-a4dd-63e50d639b2b",
    "parentuserid": 2,
    "fromname": "sample string 3",
    "fromnumber": "sample string 4",
    "name": "sample string 5",
    "content": "sample string 6",
    "isdeleted": true,
    "totalsent": 8,
    "totalsucceeded": 9,
    "totalopens": 10,
    "totalfailed": 11,
    "canunsubscribe": true,
    "totalunsubscribed": 13,
    "unsubscribetext": "sample string 14",
    "totalcredits": 15,
    "wizardmaxstep": 64,
    "wizardcurrentstep": 64,
    "statustype": 0,
    "sendingprofileid": 16,
    "totalclicks": 17,
    "totaluniqueclicks": 18,
    "islinktracking": true,
    "sendtype": 1,
    "groupids": [
      1,
      2
    ],
    "mobilenumbers": {
      "sample string 1": 2,
      "sample string 3": 4
    },
    "restricatedgroupids": [
      1,
      2
    ],
    "restricatedcampaignids": [
      "0bb12b59-9ca5-4e5f-a402-f27dec42889b",
      "51c2176e-85fb-440a-844f-28aef58fac46"
    ],
    "links": [
      {
        "id": "10330eaa-1bce-47d7-b87d-8e97cd9013fb",
        "position": 2,
        "url": "sample string 3",
        "dateCreatedUtc": "2016-12-24T14:12:12"
      },
      {
        "id": "10330eaa-1bce-47d7-b87d-8e97cd9013fb",
        "position": 2,
        "url": "sample string 3",
        "dateCreatedUtc": "2016-12-24T14:12:12"
      }
    ],
    "scheduledtimezoneid": 1,
    "scheduleddateutc": "2016-12-24T14:12:12",
    "datesentutc": "2016-12-24T14:12:12",
    "datecreatedutc": "2016-12-24T14:12:12",
    "dateupdatedutc": "2016-12-24T14:12:12",
    "datedeletedutc": "2016-12-24T14:12:12",
    "schemaid": 21,
    "templateid": "sample string 22",
    "type": 1,
    "attachments": [
      {
        "Url": "sample string 1",
        "Type": 0
      },
      {
        "Url": "sample string 1",
        "Type": 0
      }
    ],
    "removalword": "sample string 23"
  },
  "send_type_name": "sample string 1",
  "status_name": "sample string 2",
  "status_date": "2016-12-24T14:12:12",
  "handled_date": "2016-12-24T14:12:12"
}

application/xml, text/xml

Sample:
<ApiWhatsAppCampaignInfoCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.WhatsApp.WhatsAppCampaignReport">
  <campaign xmlns:d2p1="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.WhatsApp.Campaign">
    <d2p1:Attachments xmlns:d3p1="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.WhatsApp.Message">
      <d3p1:WhatsAppAttachment>
        <d3p1:Type>IMAGE</d3p1:Type>
        <d3p1:Url>sample string 1</d3p1:Url>
      </d3p1:WhatsAppAttachment>
      <d3p1:WhatsAppAttachment>
        <d3p1:Type>IMAGE</d3p1:Type>
        <d3p1:Url>sample string 1</d3p1:Url>
      </d3p1:WhatsAppAttachment>
    </d2p1:Attachments>
    <d2p1:CanUnsubscribe>true</d2p1:CanUnsubscribe>
    <d2p1:Content>sample string 6</d2p1:Content>
    <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
    <d2p1:DateDeletedUtc>2016-12-24T14:12:12</d2p1:DateDeletedUtc>
    <d2p1:DateSentUtc>2016-12-24T14:12:12</d2p1:DateSentUtc>
    <d2p1:DateUpdatedUtc>2016-12-24T14:12:12</d2p1:DateUpdatedUtc>
    <d2p1:FromName>sample string 3</d2p1:FromName>
    <d2p1:FromNumber>sample string 4</d2p1:FromNumber>
    <d2p1:GroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:GroupIds>
    <d2p1:Id>5cbc4b86-ce5d-4ee5-a4dd-63e50d639b2b</d2p1:Id>
    <d2p1:IsDeleted>true</d2p1:IsDeleted>
    <d2p1:IsLinkTracking>true</d2p1:IsLinkTracking>
    <d2p1:Links>
      <d2p1:WhatsAppCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>10330eaa-1bce-47d7-b87d-8e97cd9013fb</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:WhatsAppCampaignLink>
      <d2p1:WhatsAppCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>10330eaa-1bce-47d7-b87d-8e97cd9013fb</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:WhatsAppCampaignLink>
    </d2p1:Links>
    <d2p1:MobileNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringlong>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>2</d3p1:Value>
      </d3p1:KeyValueOfstringlong>
      <d3p1:KeyValueOfstringlong>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>4</d3p1:Value>
      </d3p1:KeyValueOfstringlong>
    </d2p1:MobileNumbers>
    <d2p1:Name>sample string 5</d2p1:Name>
    <d2p1:ParentUserId>2</d2p1:ParentUserId>
    <d2p1:RemovalWord>sample string 23</d2p1:RemovalWord>
    <d2p1:RestricatedCampaignIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>0bb12b59-9ca5-4e5f-a402-f27dec42889b</d3p1:guid>
      <d3p1:guid>51c2176e-85fb-440a-844f-28aef58fac46</d3p1:guid>
    </d2p1:RestricatedCampaignIds>
    <d2p1:RestricatedGroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:RestricatedGroupIds>
    <d2p1:ScheduledDateUtc>2016-12-24T14:12:12</d2p1:ScheduledDateUtc>
    <d2p1:ScheduledTimeZoneId>1</d2p1:ScheduledTimeZoneId>
    <d2p1:SchemaId>21</d2p1:SchemaId>
    <d2p1:SendType>Regular</d2p1:SendType>
    <d2p1:SendingProfileId>16</d2p1:SendingProfileId>
    <d2p1:StatusType>None</d2p1:StatusType>
    <d2p1:TemplateId>sample string 22</d2p1:TemplateId>
    <d2p1:TotalClicks>17</d2p1:TotalClicks>
    <d2p1:TotalCredits>15</d2p1:TotalCredits>
    <d2p1:TotalFailed>11</d2p1:TotalFailed>
    <d2p1:TotalOpens>10</d2p1:TotalOpens>
    <d2p1:TotalSent>8</d2p1:TotalSent>
    <d2p1:TotalSucceeded>9</d2p1:TotalSucceeded>
    <d2p1:TotalUniqueClicks>18</d2p1:TotalUniqueClicks>
    <d2p1:TotalUnsubscribed>13</d2p1:TotalUnsubscribed>
    <d2p1:Type>Template</d2p1:Type>
    <d2p1:UnsubscribeText>sample string 14</d2p1:UnsubscribeText>
    <d2p1:WizardCurrentStep>64</d2p1:WizardCurrentStep>
    <d2p1:WizardMaxStep>64</d2p1:WizardMaxStep>
  </campaign>
  <handled_date>2016-12-24T14:12:12</handled_date>
  <send_type_name>sample string 1</send_type_name>
  <status_date>2016-12-24T14:12:12</status_date>
  <status_name>sample string 2</status_name>
</ApiWhatsAppCampaignInfoCampaign>