Phoenix

CreateMessage

Create a new message

Request Parameters

Name Type Description Required?
DataMessage[]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:CreateMessage xmlns:api1="http://api.phoenixplatform.com">
         <api1:request>
             <tig:Id>1</tig:Id>
             <tig:ProjectId>1</tig:ProjectId>
             <tig:AccountId>1</tig:AccountId>
             <tig:MessageTypeId>Email</tig:MessageTypeId>
             <tig:DirectionTypeId>Inbound</tig:DirectionTypeId>
             <tig:SenderAddress>TestValue[42293bce6b2348dcae00c4ea56b9fa02]</tig:SenderAddress>
             <tig:StatusTypeId>Failure</tig:StatusTypeId>
             <tig:StatusDesc>TestValue[dc844b521e474a1cbbef57b0b9c3af9b]</tig:StatusDesc>
             <tig:ProcessDate>2019-12-14T08:02:00.5217575+00:00</tig:ProcessDate>
             <tig:Location>POINT(-157.7964 21.3114)</tig:Location>
             <tig:Payload>TestValue[06ed90c5a91442b7ae879e217e2630b1]</tig:Payload>
             <tig:ExpectedRecipientCount>1</tig:ExpectedRecipientCount>
             <tig:Subject>TestValue[d0815efde4554455946eea38901cd463]</tig:Subject>
             <tig:ModifyDate>2019-12-14T08:02:00.5217575+00:00</tig:ModifyDate>
         </api1:request>
      </api1:CreateMessage>
   </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:Message>
                <b:AccountId>0</b:AccountId>
                <b:CreateDate>2019-12-14T08:02:00.5217575Z</b:CreateDate>
                <b:ModifyDate>2019-12-14T08:02:00.5217575Z</b:ModifyDate>
                <b:ProjectId>0</b:ProjectId>
                <b:RecipientCount>0</b:RecipientCount>
                <b:Recipients />
  </b:Message>
</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}/messages? HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json; charset=utf-8
Authorization: Bearer [YOUR SUPER SECURE TOKEN]
Content-Length: 1206
Host: [CallHost]
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)-
 
[{
 "Id" : 1,
 "ProjectId" : 1,
 "AccountId" : 1,
 "MessageTypeId" : "AndroidPushNotification",
 "DirectionTypeId" : "Outbound",
 "SenderAddress" : "TestValue[05d435eae8b140eda0a7b1e323b245fc]",
 "StatusTypeId" : "Failure",
 "StatusDesc" : "TestValue[bd6019419eb744528823ba30342c63ef]",
 "ProcessDate" : "2019-12-14T08:02:00.5217575+00:00",
 "Location" : "POINT(-157.7964 21.3114)",
 "Payload" : "TestValue[0db6f347ea1e4204a52b132b37b79d65]",
 "ExpectedRecipientCount" : 1,
 "Subject" : "TestValue[ad01f38bcad843c696a7668e54f18cdf]",
 "ModifyDate" : "2019-12-14T08:02:00.5217575+00:00"
}]
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,
  "AccountId": 0,
  "RecipientCount": 0,
  "CreateDate": "2019-12-14T08:03:07.0841815Z",
  "ModifyDate": "2019-12-14T08:03:07.0841815Z",
  "Recipients": []
}]

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.CreateMessage(new PhoenixService.CreateMessageRequest() 
{ 
    Data = new[] 
    { 
        new PhoenixService.Message() 
        {
          Id = 1,
          ProjectId = 1,
          AccountId = 1,
          MessageTypeId = PhoenixService.MessageTypeEnum.Webhook,
          DirectionTypeId = PhoenixService.DirectionTypeEnum.Outbound,
          SenderAddress = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          StatusTypeId = PhoenixService.StatusTypeEnum.PartialSuccess,
          StatusDesc = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          ProcessDate = DateTime.UtcNow,
          Location = new PhoenixService.DbGeography() { Geography = new PhoenixService.DbGeographyWellKnownValue() { WellKnownText = "POINT(POINT(-157.7964 21.3114))"}},
          Payload = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          ExpectedRecipientCount = 1,
          Subject = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          ModifyDate = DateTime.UtcNow
        }
    } 
}));