Phoenix

CreateBroadcast

Create a new broadcast to be sent at a later date

Request Parameters

Name Type Description Required?
DataBroadcast[]UnavailableRequired
ProjectIdSystem.Int32UnavailableRequired
ProjectIdSystem.Int32UnavailableRequired

Validation

Name Type Description Required?
ProjectIdSystem.Int32IdRequired

Endpoints

Sample Request
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.phoenixplatform.net" xmlns:tig="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:tig1="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services.Filters">
    <soapenv:Header>
      <PhoenixHeader xmlns="http://api.phoenixplatform.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
         <AccessToken>[YOUR ACCESS TOKEN]</AccessToken>
         <Phoenix-ProjectId>1</Phoenix-ProjectId>
      </PhoenixHeader>
   </soapenv:Header>
   <soapenv:Body>
      <api1:CreateBroadcast xmlns:api1="http://api.phoenixplatform.com">
         <api1:request>
             <tig:Id>1</tig:Id>
             <tig:ProjectId>1</tig:ProjectId>
             <tig:PhoenixIdentity_GroupId>1</tig:PhoenixIdentity_GroupId>
             <tig:ExcludeRecipientAddress>TestValue[36d445051407482cb8dc4f4c0670c107]</tig:ExcludeRecipientAddress>
             <tig:TemplateGroupId>1</tig:TemplateGroupId>
             <tig:AccountId>1</tig:AccountId>
             <tig:Subject>TestValue[33a1b611761545299e73fa42c7408e4b]</tig:Subject>
             <tig:Payload>TestValue[21aaef1672b649909659b21f4c5966ee]</tig:Payload>
             <tig:SenderAddress>TestValue[9f72b3ef06d74d2b92123f1d04ad15d8]</tig:SenderAddress>
             <tig:DeliverAfterDate>2021-01-27T09:30:44.9518054+00:00</tig:DeliverAfterDate>
             <tig:SendIndividualMessages>true</tig:SendIndividualMessages>
             <tig:IsProcessing>true</tig:IsProcessing>
             <tig:StatusTypeId>Sending</tig:StatusTypeId>
             <tig:SentDate>2021-01-27T09:30:44.9520391+00:00</tig:SentDate>
             <tig:ModifyDate>2021-01-27T09:30:44.9520391+00:00</tig:ModifyDate>
             <tig:StatusDescription>TestValue[5c3eeac461394f078c1d1f98d5319dea]</tig:StatusDescription>
             <tig:Substitutes>new Dictionary<string, string>()</tig:Substitutes>
         </api1:request>
      </api1:CreateBroadcast>
   </soapenv:Body>
</soapenv:Envelope>
Sample Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="d088e8c6-bf1e-4a9d-9e96-3f5faf232af5" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">17abb643-6b2f-4485-b4ff-0afc30697b7d</ActivityId>
   </s:Header>
   <s:Body>
      <MessagingResponse xmlns="http://api.phoenixplatform.com">
         <MessagingResult xmlns:a="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Syndicate.Services.Contracts.Article" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <b:Data xmlns="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services" xmlns:b="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Messaging.Model">
              <b:Broadcast>
                <b:CreateDate>2021-01-27T09:30:44.9520391Z</b:CreateDate>
                <b:DeliverAfterDate>0001-01-01T00:00:00</b:DeliverAfterDate>
                <b:IsProcessing>false</b:IsProcessing>
                <b:ModifyDate>2021-01-27T09:30:44.9520391Z</b:ModifyDate>
                <b:PhoenixIdentity_GroupId>0</b:PhoenixIdentity_GroupId>
                <b:ProjectId>0</b:ProjectId>
                <b:SendIndividualMessages>false</b:SendIndividualMessages>
                <b:Substitutes xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  </b:Broadcast>
</b:Data>
            <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services">1</TotalRecords>
         </MessagingResult>
      </MessagingResponse>
   </s:Body>
</s:Envelope>
Resource URL

Sample Request

POST /projects/{projectid}/Broadcasts? HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json; charset=utf-8
Authorization: Bearer [YOUR SUPER SECURE TOKEN]
Content-Length: 1516
Host: [CallHost]
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)-
 
[{
 "Id" : 1,
 "ProjectId" : 1,
 "PhoenixIdentity_GroupId" : 1,
 "ExcludeRecipientAddress" : "TestValue[b479ec3727f049229fd774fbfef71a79]",
 "TemplateGroupId" : 1,
 "AccountId" : 1,
 "Subject" : "TestValue[7bccd96bca5f457e9098cec5a77b65a5]",
 "Payload" : "TestValue[788226484fff469a8e4a60867f8c42d8]",
 "SenderAddress" : "TestValue[35b422ff104342efa0d09efa67526ebc]",
 "DeliverAfterDate" : "2021-01-27T09:30:44.9504185+00:00",
 "SendIndividualMessages" : true,
 "IsProcessing" : true,
 "StatusTypeId" : "Sending",
 "SentDate" : "2021-01-27T09:30:44.9504185+00:00",
 "ModifyDate" : "2021-01-27T09:30:44.9504185+00:00",
 "StatusDescription" : "TestValue[41aee4fc094e45a79942798afa8ca7ed]",
 "Substitutes" : new Dictionary<string, string>()
}]
Sample Response
HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 200
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,OPTIONS
Access-Control-Allow-Headers: Content-Type

[{
  "ProjectId": 0,
  "PhoenixIdentity_GroupId": 0,
  "DeliverAfterDate": "0001-01-01T00:00:00",
  "SendIndividualMessages": false,
  "IsProcessing": false,
  "CreateDate": "2021-01-27T10:20:34.2733516Z",
  "ModifyDate": "2021-01-27T10:20:34.2733516Z",
  "Substitutes": {}
}]

Nuget

PM> Install-Package PhoenixServiceHelper

PhoenixServiceHelper Sample

using System;
using System.Collections.Generic;

using Tigerspike.Phoenix.Services.Api.ServiceConfiguration;
using Tigerspike.Phoenix.Services.Api.ServiceRequest;
using PhoenixService = Tigerspike.PhoenixMessaging.V1;
using Tigerspike.Phoenix.Services.Api;

var request = new SoapServiceRequest() { Token = "[YOUR SUPER SECURE TOKEN]", ProjectId = 1 };
var configuration = CustomConfigurationFactory.CreateServiceConfiguration(Assembly.GetExecutingAssembly());

var proxy = new PhoenixServiceHelper<PhoenixService.IPhoenixMessagingService>(configuration);
var response = proxy.Execute(request, o => o.CreateBroadcast(new PhoenixService.CreateBroadcastRequest() 
{ 
    Data = new[] 
    { 
        new PhoenixService.Broadcast() 
        {
          Id = 1,
          ProjectId = 1,
          PhoenixIdentity_GroupId = 1,
          ExcludeRecipientAddress = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          TemplateGroupId = 1,
          AccountId = 1,
          Subject = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          Payload = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          SenderAddress = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          DeliverAfterDate = DateTime.UtcNow,
          SendIndividualMessages = true,
          IsProcessing = true,
          StatusTypeId = PhoenixService.BroadcastStatusTypeEnum.Sent,
          SentDate = DateTime.UtcNow,
          ModifyDate = DateTime.UtcNow,
          StatusDescription = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          Substitutes = new Dictionary<string, string>()
        }
    } 
}));