QUERY TEXTS

Use the QueryTexts method to list text messages that have been sent and received.

Query for text messages using standard ActionQuery which filters on batchId, broadcastId, toNumber, etc. Returns a list of text messages and all associated info. See GetText to return just a single text action by id.

Request Parameters

Response Parameters

State Options

READY:

The Call or Text is waiting to be executed.

SELECTED:

The Call or Text is currently being executed.

CALLBACK:

The Call will be retried probably because the number was busy.

FINISHED:

The Call or Text has been executed successfully.

DNC (call):

The Call or Text is to a number that is on a do-not-call list.

DUP:

The Call or Text is to a number which is already waiting to be executed.

INVALID:

The Call or Text is to a number which is in a bad format or otherwise incorrect.

TIMEOUT:

The Call or Text was attempted but the result has not been reported back.

Results for Calls

Live Answer:

The call was answered by a person.

Answering Machine:

The call was answered by an answering machine.

BUSY

The phone number was in a call already.

Do Not Call:

The Call was to a number that is on a do-not-call list.

Transfer:

The call was transferred.

No Answer:

No answer was obtained.

Transfer Leg:

The Call became part of a transfer.

Results for Texts

SENT:

The text message was sent successfully.

RECEIVED:

A reply to your text message was received.

Do Not Text:

The phone number is on a Do Not Text list.

Msg Too Big:

The text message was too long to be sent.

Results for both Call and Text

Internal Error:

The CallFire's service had an error. You should retry or call CallFire Support.

Carrier Error

The local telephone carrier is temporarily overloaded, or a high dialing speed to a certain location is causing the telecom provider to reject calls, or the phone number is disconnected.

Recoverable Carrier Error:

The local telephone carrier had a temporary error but the message will be retried by the Carrier.

Responses Status Codes

200, success

The request has been finished successfully.

400, bad request

This error code has a lot of possible causes, such as an account error or an incorrect parameter. First of all, check that all parameters have the correct data or data type. If the error persists, contact CallFire support.

401, not authorized

The username or password has some error. Perhaps the login has expired. Make sure that you valid account.

404, not found

The ID or Number that you are trying to edit or get was not found; you should check to see if it is correct.

500, internal error

This error is not caused by the user, but is CallFire's. Please contact support.

Example: QueryTexts

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string QueryText()
        {
            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest("text", Method.GET);
            request.AddParameter("MaxResults", "5");
            request.AddParameter("BroadcastId", "1903340001");
            request.AddParameter("IntervalBegin", "2015-01-01T21:32:52Z");
            request.AddParameter("IntervalEnd", "2016-10-26T05:36:10Z");

            var response = client.Execute(request);
            string content = response.Content;
            return content;
        }
    }
}

The XML returned is:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<r:ResourceList xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource" totalResults="302">

    <Text id="328">

       <FromNumber>67076</FromNumber>

     <ToNumber>14242709722</ToNumber>

       <State>FINISHED</State>

       <BroadcastId>1876425001</BroadcastId>

       <ContactId>264793000003</ContactId>

       <Inbound>false</Inbound>

       <Created>2014-12-02T19:28:18Z</Created>

       <Modified>2014-12-02T19:28:20Z</Modified>

       <FinalResult>SENT</FinalResult>

       <Message>Testing</Message>

       <TextRecord id="214742362003">

          <Result>SENT</Result>

          <FinishTime>2014-12-02T19:28:18Z</FinishTime>

          <BilledAmount>1.0</BilledAmount>

          <Message>Testing</Message>

       </TextRecord>

    </Text>

</r:ResourceList>