HTTP POST API V4. Introduction

This simple HTTP POST API is designed for the reqeusts to be submitted as simple HTTP POST requests. If the post request includes the field "ShowForm" then this form will be displayed as well as html encoded output. If you are interfacing with this programatically, leave that field out to get simple status codes and XML reports.

This is version 4. Click here for version 3.

Submit Job










Note, in the recipient field, comma's in the reference or recipient field can be escaped with "\,".
You can send to multiple recipients by separating recipient details with a |
eg. "user200, Jane Smith, 1234567890|user201, Fred Jones, 9876543210"
or just: "1234567890|9876543210"

API Post details

Form URL: https://portal.emailtovoice.net/htmlapi.asp
Field Details
Action This field must be set to "SendJob".
Version This is version "4".
Username The user submitting the job. eg "au/johnsmith".
Password Password for the user submitting the job.
JobName Standard job name. If blank a standard name will be set.
JobType One of "SMS", "2 Way SMS", "Text-to-speech", "2 Way TTS".
From Sender id for SMS jobs. Has no affect for TTS jobs.
Header Text for Header part of TTS message. Has no affect for SMS jobs.
Message The SMS content or main part of the TTS message.
Recipients Recipient details for message. See notes in form for details.

Response

On success the response will be a string with the job number, and http status:200
On Fail, the response will be a string with the error deails and http status:422 (for data errors)

User Job List Report

Must be the user in question, or their admin/agent. eg, "adminlogin"

User to get job list for. eg. "au/johnsmith", or an agents username to get details of jobs for their users.

eg. 20/1/2022. If blank then list will be from first job submitted
eg. 22/1/2022. Includes this date. If blank then list will be to current date
1 is the first page.
Default page length is 100, Maximum page length is 1000
Order by when the job was created

API Post details

Form URL: https://portal.emailtovoice.net/htmlapi.asp
Field Details
Action This field must be set to "ListJobs".
Username Must be the user in question, or their admin/agent. eg, "adminlogin".
Password Password for the username above.
UserCode User to get job list for. eg. "au/johnsmith".
IncludeRecipients If set to true, will return a <Recipients> node containing details of the job recipients and each delivery status.(optional)
StartDate Format "dd/mm/yyyy" eg. 22/1/2020. If blank then list will be from first job submitted. (optional)
EndDate Format "dd/mm/yyyy" eg. 22/1/2022. Includes this date. If blank then list will be to current date. (optional)
Page The page of results to return. 1 is the first page. (optional)
PageLength Length of each page of results. Default page length is 100, Maximum page length is 1000. (optional)
SortOrder Order of jobs to be displayed. Either Ascending (default) or Descending. (optional)
Version This is version "4".

Response Sample

<?xml version="1.0" encoding="UTF-8"?>
<ListJobs>
  <UserCode>au/test</UserCode>
  <StartDate>1/1/2022</StartDate>
  <EndDate>1/2/2022</EndDate>
  <TotalRecords>18</TotalRecords>
  <CurrentPage>1</CurrentPage>
  <TotalPages>7</TotalPages>
  <PageLength>3</PageLength>
  <Jobs>
    <Job>
      <BroadcastID>45678912</BroadcastID>
      <BroadcastType>Text-To-Speech</BroadcastType>
      <BroadcastName>test</BroadcastName>
      <BroadcastStatus>Complete</BroadcastStatus>
      <StartDate>12/01/2022 5:32:39 AM</StartDate>
      <CompleteDate>12/01/2022 5:34:46 AM</CompleteDate>
      <ScheduledDate></ScheduledDate>
      <TotalRecipients>1</TotalRecipients>
      <SentRecipients>1</SentRecipients>
      <FailedRecipients>0</FailedRecipients>
      <NumPages>1</NumPages>
      <TotalAmount>0.29</TotalAmount>
      <Recipients>
        <Recipient>
          <Destination>1234567890</Destination>
          <Reference>User123</Reference>
          <Recipient>Fred Smith</Recipient>
          <Status>SENT</Status>
          <MessageCost>0.03</MessageCost>
          <DeliveryTime>12/01/2022 5:34:46 AM</DeliveryTime>
        </Recipient>
       </Recipients>
    </Job>
    <Job>
      <BroadcastID>45678919</BroadcastID>
      <BroadcastType>2 Way SMS</BroadcastType>
      <BroadcastName>Another Test</BroadcastName>
      <BroadcastStatus>Complete</BroadcastStatus>
      <StartDate>14/01/2022 6:27:23 PM</StartDate>
      <CompleteDate>14/01/2022 6:30:01 PM</CompleteDate>
      <ScheduledDate></ScheduledDate>
      <TotalRecipients>2</TotalRecipients>
      <SentRecipients>2</SentRecipients>
      <FailedRecipients>0</FailedRecipients>
      <NumPages>1</NumPages>
      <TotalAmount>0.491</TotalAmount>
      <Recipients>
        <Recipient>
          <Destination>1234567890</Destination>
          <Reference>User123</Reference>
          <Recipient>Fred Smith</Recipient>
          <Status>FAIL</Status>
          <MessageCost>0</MessageCost>
          <DeliveryTime>14/01/2022 6:30:00 PM</DeliveryTime>
        </Recipient>
       </Recipients>
    </Job>
    <Job>
      <BroadcastID>45678945</BroadcastID>
      <BroadcastType>2 Way TTS</BroadcastType>
      <BroadcastName>Test TTS</BroadcastName>
      <BroadcastStatus>Complete</BroadcastStatus>
      <StartDate>14/01/2022 6:28:38 PM</StartDate>
      <CompleteDate>14/01/2022 6:30:02 PM</CompleteDate>
      <ScheduledDate></ScheduledDate>
      <TotalRecipients>1</TotalRecipients>
      <SentRecipients>1</SentRecipients>
      <FailedRecipients>0</FailedRecipients>
      <NumPages>1</NumPages>
      <TotalAmount>0.29</TotalAmount>
      <Recipients>
        <Recipient>
          <Destination>1234567890</Destination>
          <Reference>User123</Reference>
          <Recipient>Fred Smith</Recipient>
          <Status>SENT</Status>
          <MessageCost>0.03</MessageCost>
          <DeliveryTime>14/01/2022 6:30:01 PM</DeliveryTime>
        </Recipient>
       </Recipients>
    </Job>
  </Jobs>
</ListJobs>

Get Job Details

Must be the job owner, or their admin/agent. eg."adminlogin"

eg.12345678
1 is the first page
Maximum page length is 1000

API Post details

Form URL: https://portal.emailtovoice.net/htmlapi.asp
Field Details
Action This field must be set to "JobDetails".
Username Must be the job owner, or their admin/agent. eg, "adminlogin".
Password Password for the username above.
BroadcastID Broadcast ID for the job in question. eg. "12345678".
Page The page of results to return. 1 is the first page.
PageLength Length of each page of results. Default page length is 100, Maximum page length is 1000.
Version This is version "4".

Response Sample

<?xml version="1.0" encoding="UTF-8"?>
<Job>
  <BroadcastID>45086716</BroadcastID>
  <BroadcastType>SMS</BroadcastType>
  <BroadcastName>APITestSMS</BroadcastType>
  <StartDate>11/03/2022 6:29:30 AM</StartDate>
  <CompleteDate>11/03/2022 6:30:02 AM</CompleteDate>
  <ScheduledDate></ScheduledDate>
  <TotalRecipients>1</TotalRecipients>
  <SentRecipients>1</SentRecipients>
  <FailedRecipients>0</FailedRecipients>
  <NumPages>1</NumPages>
  <TotalAmount>0.2455</TotalAmount>
  <RecipientsCount>1</RecipientsCount>
  <RecipientsPageLength>100</RecipientsPageLength>
  <RecipientsCurrentPage>1</RecipientsCurrentPage>
  <RecipientsTotalPages>1</RecipientsTotalPages>
   <Recipients> 
     <Recipient> 
       <Destination>+61427185038</Destination> 
       <Reference></Reference> 
       <Recipient></Recipient> 
       <Status>SENT</Status> 
       <MessageCost>0.1</MessageCost> 
       <DeliveryTime>2023-11-20 14:53:26</DeliveryTime> 
     </Recipient> 
   </Recipients> 
</Job>

Get User Details

A given user, or agent

1 is the first page
Maximum page length is 1000

If an agent login is given then a page of their users details will be listed.

API Post details

Form URL: https://portal.emailtovoice.net/htmlapi.asp
Field Details
Action This field must be set to "UserDetails".
Username A given username or an agent.
Password Password for the username above.
Page The page of results to return. 1 is the first page.
PageLength Length of each page of results. Default page length is 100, Maximum page length is 1000.
Version This is version "4".

Response Sample

<?xml version="1.0" encoding="UTF-8"?>
<Users>
  <User>
    <UserID>1234</UserID>
    <UserName>testuser</UserName>
    <FirstName>Jane</FirstName>
    <LastName>Smith</LastName>
    <Email>jsmith@test.com</Email>
    <Phone>1234567890</Phone>
    <Fax></Fax>
    <CompanyName>MyCompany</CompanyName>
    <CompanyAddress>123 test road</CompanyAddress>
    <CompanySuburb>testville</CompanySuburb>
    <CompanyState>Vic</CompanyState>
    <CompanyPostCode>3456</CompanyPostCode>
    <CompanyCountry>Australia</CompanyCountry>
    <AgentUserName>agt/ttest-999</AgentUserName>
  </User>
  <UserCount>1</userCount>
  <Page>1</Page>
  <PageLength>100</PageLength>
  <TotalPages>1</TotalPages>
</Users>