Exigo Web Services API v2022.12.19.1

OptInSms

Setup opt in settings for Sms messaging by phone number.

Input Properties

OptInSmsRequest
PropertyData TypeNotes
CustomerIDInt32Optional. The CustomerID being opted in. Use either CustomerID or phone number.
PhoneNumberStringOptional. The phone number you are opting in.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

OptInSmsResponse
PropertyData TypeNotes
RecordsAffectedInt32

Http Request

POST https://yourcompany-api.exigo.com/3.0/sms/optin HTTP/1.1
Content-Type: application/json
Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword)

{ "customerID": 1, "phoneNumber": "(888) 555-1234", "customerKey": "1" }

Http Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

{ "recordsAffected": 1, "result": null }

Soap Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/OptInSms"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <OptInSmsRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <PhoneNumber>string</PhoneNumber> <CustomerKey>string</CustomerKey> </OptInSmsRequest> </soap:Body> </soap:Envelope>

Soap Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <OptInSmsResult xmlns="http://api.exigo.com/"> <RecordsAffected>int</RecordsAffected> </OptInSmsResult> </soap:Body> </soap:Envelope>

C# Rest Client

Install Nuget package Exigo.Api.Client

try

{

    //Create Api Client

    var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");

 

    //Create Request

    var req = new OptInSmsRequest();

 

    req.CustomerID = 1;             //The CustomerID being opted in. Use either CustomerID or phone number.

    req.PhoneNumber = "(888) 555-1234";//The phone number you are opting in.

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

 

    //Send Request to Server and Get Response

    var res = await api.OptInSmsAsync(req);

 

    //Now examine the results:

    Console.WriteLine("RecordsAffected: {0}", res.RecordsAffected);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

C# Soap Client

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    OptInSmsRequest req = new OptInSmsRequest();

 

    req.CustomerID = 1;             //The CustomerID being opted in. Use either CustomerID or phone number.

    req.PhoneNumber = "(888) 555-1234";//The phone number you are opting in.

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

 

    //Send Request to Server and Get Response

    OptInSmsResponse res = api.OptInSms(req);

 

    //Now examine the results:

    Console.WriteLine("RecordsAffected: {0}", res.RecordsAffected);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new OptInSmsRequest()

 

    req.CustomerID = 1

    req.PhoneNumber = "(888) 555-1234"

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As OptInSmsResponse = api.OptInSms(req)

 

    'Now examine the results:

    Console.WriteLine("RecordsAffected: {0}", res.RecordsAffected)

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->CustomerID = 1;

    $req->PhoneNumber = "(888) 555-1234";

    $req->CustomerKey = "1";

 

    //Send Request to Server and Get Response

    $res = $api.OptInSms($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    OptInSmsRequest req = new OptInSmsRequest();

 

    req.setCustomerID(1);

    req.setPhoneNumber("(888) 555-1234");

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    OptInSmsResponse res = api.getExigoApiSoap().optInSms(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.