Consumer Contact Lite

LIVE

http://imagin8.co.za/api/json/individual/ConsumerContactLite

SANDBOX

http://imagin8.co.za/api/json/sandbox/individual/ConsumerContactLite


The lite version of the Consumer Contact API. You get basic details of an individual.

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
IDNo string Query Param required The ID Number of the indvidual being enquired

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'http://imagin8.co.za/api/json/sandbox/individual/ConsumerContactLite?IDNo=8209147250087'

Response

{
    "TransactionSuccessful": true,
    "IDNumber": "8209147250087",
    "PassportNumber": "",
    "Initials": "J",
    "FirstName": "JOHN",
    "SecondName": "",
    "ThirdName": "",
    "LastName": "DOE",
    "Gender": "Male",
    "BirthDate": "1982-09-14",
    "TitleDesc": "Mister",
    "MaritalStatus": "",
    "PrivacyStatus": "ACCEPTS CONTACTS",
    "ResidentialAddress": "",
    "PostalAddress": "",
    "HomeTelephone": "",
    "WorkTelephone": "",
    "CellNo": "",
    "EmailAddress": "",
    "Employer": "",
    "YourReference": "",
    "TransactionID": 66691,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Consumer Contact

LIVE

https://imagin8.co.za/api/json/individual/ConsumerContact

SANDBOX

https://imagin8.co.za/api/json/sandbox/individual/ConsumerContact


Retrieve a users details

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
IDNo string Query Param required The ID Number of the individual

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://imagin8.co.za/api/json/sandbox/individual/ConsumerContact?IDNo=8209147250087'

Response

{
    "TransactionSuccessful": true,
    "ContactsLinkedToCell": [],
    "IDNumber": "8209147250087",
    "PassportNumber": "",
    "Initials": "J",
    "FirstName": "JOHN",
    "SecondName": "",
    "ThirdName": "",
    "LastName": "DOE",
    "Gender": "Male",
    "TitleDesc": "Mister",
    "MaritalStatus": "Unknown",
    "PrivacyStatus": "ACCEPTS CONTACTS",
    "Deceased": "U",
    "Addresses": [
        {
            "AdrsLine1": "80 STRAND STREET",
            "AdrsLine2": "CAPE TOWN",
            "AdrsLine3": "CAPE TOWN",
            "AdrsLine4": "CAPE TOWN",
            "PostalCode": "8001",
            "AdrsType": "Residential",
            "LastUpdated": "2016-09-06",
            "CreatedDate": "2016-07-26"
        }
    ],
    "TelephoneNumbers": [
        {
            "Telephone": "0215445616",
            "TelephoneType": "Home",
            "LastUpdated": "2016-09-07",
            "CreatedDate": "2016-07-26"
        }
    ],
    "Employers": [
        {
            "BranchCode": "",
            "EmpName": "TEST ONE",
            "Occupation": "",
            "LastUpdated": "2016-09-07",
            "CreatedDate": "2016-07-26"
        }
    ],
    "EmailAddresses": [],
    "TransactionID": 66692,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Consumer Contact Pro

LIVE

http://imagin8.co.za/api/json/individual/ConsumerContactPro

SANDBOX

http://imagin8.co.za/api/json/sandbox/individual/ConsumerContactPro


The pro version of Consumer Contact. Brings back all the information of the original consumer contact call as well as additional data like a credit score and insurance and vehicle finance accounts.

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
IDNo string Query Param required The ID Number of the Individual being enquired

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'http://imagin8.co.za/api/json/sandbox/individual/ConsumerContactPro?IDNo=8209147250087'

Response

{
    "TransactionSuccessful": true,
    "IDNumber": "8209147250087",
    "PassportNumber": "",
    "Initials": "J",
    "FirstName": "JOHN",
    "SecondName": "",
    "ThirdName": "",
    "LastName": "DOE",
    "Gender": "Male",
    "TitleDesc": "Mister",
    "MaritalStatus": "Unknown",
    "PrivacyStatus": "ACCEPTS CONTACTS",
    "Deceased": "U",
    "HomeAffairsVerified": "N",
    "CreditScore": "N/A",
    "PostalAddresses": [],
    "ResidentialAddresses": [
        {
            "AdrsLine1": "",
            "AdrsLine2": "",
            "AdrsLine3": "",
            "AdrsLine4": "",
            "PostalCode": "",
            "AdrsType": "",
            "LastUpdated": "",
            "CreatedDate": ""
        },
        {
            "AdrsLine1": "",
            "AdrsLine2": "",
            "AdrsLine3": "",
            "AdrsLine4": "",
            "PostalCode": "",
            "AdrsType": "",
            "LastUpdated": "",
            "CreatedDate": ""
        }
    ],
    "HomeTelephoneNumbers": [],
    "WorkTelephoneNumbers": [],
    "CellNumbers": [
        {
            "Telephone": "",
            "TelephoneType": "",
            "LastUpdated": "",
            "CreatedDate": ""
        },
        {
            "Telephone": "",
            "TelephoneType": "",
            "LastUpdated": "",
            "CreatedDate": ""
        }
    ],
    "Employers": [
        {
            "BranchCode": "",
            "EmpName": "",
            "Occupation": "",
            "LastUpdated": "",
            "CreatedDate": ""
        },
        {
            "BranchCode": "",
            "EmpName": "",
            "Occupation": "",
            "LastUpdated": "",
            "CreatedDate": ""
        }
    ],
    "EmailAddresses": [],
    "ShortTermInsurances": [],
    "VehicleFinanceAccounts": [],
    "TransactionID": 66693,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Get Score

LIVE

http://imagin8.co.za/api/json/individual/GetScore

SANDBOX

http://imagin8.co.za/api/json/sandbox/individual/GetScore


Retrieve an individual's credit score along with reasons impacting the score.

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
IDNo string Query Param required The ID number of the individual being enquired
Source string Query Param optional Accepted Params: CPA, NLR. Specifying a source will return results for only that source. Omit the parameter to return both.
ResultType string Query Param optional Accepted Params: F (Full), L (Limited). Defaults to F. This will return either limited information (Without reasons) or full information.
RunTTAnalysis boolean Query Param optional Accepted Params: 1 (true), 0 (false). Defaults to 0. This will return an extra value “TTAcceptance”, which would indicate that it passed/failed for the additional analysis of negative events.

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'http://imagin8.co.za/api/json/sandbox/individual/GetScore?IDNo=8209147250087&Source=NLR&ResultType=F&RunTTAnalysis=0'

Response

{
    "TransactionSuccessful": true,
    "Response": [
        {
            "TransactionCompleted": true,
            "ResultType": "NLR",
            "Score": 636,
            "Risk": "Average",
            "Accepted": "Yes",
            "IDNumber": "8209147250087",
            "Reasons": {
                "ReasonCode1": "NA12",
                "ReasonDesc1": "NA12-All accounts have limited performance history",
                "ReasonCode2": "NA52",
                "ReasonDesc2": "NA52-No Revolving Accounts Held",
                "ReasonCode3": "N/A",
                "ReasonDesc3": "N/A"
            }
        }
    ],
    "TransactionID": 66690,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Vehicle Ownership

LIVE

https://www.imagin8.co.za/api/json/individual/VehicleOwnership

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/individual/VehicleOwnership


Return the list of vehicles registered to an individual's ID number.

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
IDNo string Query Param required The ID Number of the indvidual being enquired

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/individual/VehicleOwnership?IDNo=6611095010086'

Response

{
    "IDNumber": "6611095010086",
    "Vehicles": [
        {
            "Make": "AUDI",
            "Model": "AU 21X-A1",
            "RegNo": "BL54BWGP",
            "VIN": "WAUZZZ8X7BB090318",
            "EngineNo": "CBZ396939",
            "DeptRegisterNo": "DRW522K"
        },
        {
            "Make": "AUDI",
            "Model": "AU 48X - A5 CABRIO",
            "RegNo": "FD82VLGP",
            "VIN": "WAUZZZ8F4DN012653",
            "EngineNo": "CDN328068",
            "DeptRegisterNo": "FMR136K"
        },
        {
            "Make": "LAND ROVER",
            "Model": "RANGE ROVER EVOQUE",
            "RegNo": "XANGELXGP",
            "VIN": "SALVA2AD8CH638401",
            "EngineNo": "DZ784050192224DT",
            "DeptRegisterNo": "PYH885W"
        },
        {
            "Make": "ALFA",
            "Model": "MITO",
            "RegNo": "ZGX651GP",
            "VIN": "ZAR95500001074564",
            "EngineNo": "199A00001460458",
            "DeptRegisterNo": "MMG946W"
        }
    ],
    "TransactionID": 85435,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

VIN Reg Check

LIVE

https://www.imagin8.co.za/api/json/vehicle/VinRegCheck

SANDBOX

https://www.imagin8.co.za/api/json/vehicle/VinRegCheck


Lookup a vehicle using the VIN or Registration number.

NOTE: The VIN feature is currently not enabled and vehicles can only be retrieved using the registration number.

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
Lookup string Query Param required Accepted Params : reg (Registration Number), vin (Vin Number)
VINReg string Query Param required The VIN/Registration number of the vehicle being enquired
Year string Query Param required The year model of the vehicle being enquired.
Options string Query Param optional A json string containing any of the following to further filter the list returned if any (make, derivative, engine, transmission, body)

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/vehicle/VinRegCheck?Lookup=reg&VINReg=CA332419&Year=2010&Options={"make":"RENAULT","derivative":"CLIO IV"}'

Response

{
    "TransactionSuccessful": true,
    "Data": {
        "Make": "VOLKSWAGEN",
        "Registration": "CA714325",
        "VIN": "",
        "Year": 2011,
        "RegistrationYear": 0,
        "Region": "Unknown",
        "VehiclesFound": 8,
        "PossibleModels": [
            {
                "Model": "POLO VIVO 1.4 (32010 - 82014)",
                "VehicleCode": "64020500",
                "IntroYear": 32010,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 3Dr (32010 - 32014)",
                "VehicleCode": "64020050",
                "IntroYear": 32010,
                "DisconYear": 32014
            },
            {
                "Model": "POLO VIVO 1.4 5Dr (32010 - 82014)",
                "VehicleCode": "64020100",
                "IntroYear": 32010,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 BLUELINE 5Dr (42011 - 82014)",
                "VehicleCode": "64020105",
                "IntroYear": 42011,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 TRENDLINE (32010 - 82014)",
                "VehicleCode": "64020510",
                "IntroYear": 32010,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 TRENDLINE 5Dr (32010 - 82014)",
                "VehicleCode": "64020110",
                "IntroYear": 32010,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 TRENDLINE TIP (42011 - 82014)",
                "VehicleCode": "64020520",
                "IntroYear": 42011,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 TRENDLINE TIP 5DR (42011 - 82014)",
                "VehicleCode": "64020120",
                "IntroYear": 42011,
                "DisconYear": 82014
            }
        ]
    }
}

Vehicle Data

LIVE

https://www.imagin8.co.za/api/json/vehicle/GetVehicleData

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/vehicle/GetVehicleData


No Description...

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
Lookup string Query Param required Specify either Reg or Vin depending on what you will use for the lookup.
VINReg string Query Param required The Registration or Vin number of the vehicle
Year int Query Param optional The year model of the vehicle - If a year model is passed, the system will attempt to bring back a list of possible models.

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/vehicle/GetVehicleData?Lookup=Reg&VINReg=DHF495FS&Year=2007'

Response

{
    "TransactionSuccessful": true,
    "VehicleData": {
        "RegistrationNumber": "DHF495FS",
        "RegisterNumber": "JNV219S",
        "LicenseExpiry": "2018-12-31",
        "VINNumber": "YV1MK434272007984",
        "EngineNumber": "B4204S374339",
        "Make": "VOLVO",
        "Model": "C30",
        "Year": "2007",
        "PossibleModels": [
            {
                "Model": "C30 2.0",
                "IntroYear": "32007",
                "DisconYear": "72008",
                "TruCode": "VVC3H005"
            },
            {
                "Model": "C30 T5",
                "IntroYear": "32007",
                "DisconYear": "72008",
                "TruCode": "VVC3H027"
            },
            {
                "Model": "C30 T5 GEARTRONIC",
                "IntroYear": "32007",
                "DisconYear": "72008",
                "TruCode": "VVC3H026"
            }
        ]
    },
    "TransactionID": 297793,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Check Balance

LIVE

https://www.imagin8.co.za/api/json/sms/CheckBalance

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/CheckBalance


No Description...

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/sms/CheckBalance'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 1280,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Check Message Status

LIVE

https://www.imagin8.co.za/api/json/sms/CheckMessageStatus

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/CheckMessageStatus


No Description...

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
msg_id int Query Param required The Message ID passed back after sending a message

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/sms/CheckMessageStatus?msg_id=69682389'

Response

{
    "TransactionSuccessful": true,
    "MessageID": 69682389,
    "Status": "DELIVRD",
    "Code": 101,
    "DateTime": "2019-07-17 12:04:27",
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Send Single

LIVE

https://www.imagin8.co.za/api/json/sms/Send

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/Send


No Description...

Request   POST

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
Content-Type string Header Required Body should be posted as JSON

Request


$ curl -X POST -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=" -H "Content-Type: application/json" -d 
'{ "payload": { "number":"0831234567", "msg":"Testing API V2", "return_to":"support@imagin8.co.za", "schedule":"2018-12-12T13:30:00", "ref": "My Reference" } } 'https://www.imagin8.co.za/api/json/sandbox/sms/Send'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 360,
    "MessageID": 6901885,
    "MessagesSent": 1,
    "ReturnTo": "support@imagin8.co.za",
    "Reference": "My Reference",
    "SendShedule": "2018-12-12 13:30:00",
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Send Batch

LIVE

https://www.imagin8.co.za/api/json/sms/SendBatch

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/SendBatch


No Description...

Request   POST

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
Content-Type string Header Required Body should be posted as JSON

Request


$ curl -X POST -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=" -H "Content-Type: application/json" -d 
'{ "payload": [ { "number": "0831234567", "msg": "Simple API Test Message", "return_to": "support@imagin8.co.za", "ref": "My Reference 1" }, { "number": "0837654321", "msg": "API Test Message for Recipient 2", "return_to": "support@imagin8.co.za", "ref": "My Reference 2" } ] } 'https://www.imagin8.co.za/api/json/sandbox/sms/SendBatch'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 230,
    "Attempts": 2,
    "FailedPreCondition": 0,
    "Batch": [
        {
            "MessageID": 4742835,
            "MessagesSent": 1,
            "ReturnTo": "support@imagin8.co.za",
            "Reference": "My Reference 1",
            "SendShedule": "2019-07-18 09:31:13"
        },
        {
            "MessageID": 7484898,
            "MessagesSent": 1,
            "ReturnTo": "support@imagin8.co.za",
            "Reference": "My Reference 2",
            "SendShedule": "2019-07-18 09:31:13"
        }
    ],
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

R2 Check Balance

LIVE

https://www.imagin8.co.za/api/json/sms/R2CheckBalance

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/R2CheckBalance


No Description...

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/sms/R2CheckBalance'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 0,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

R2 Check Message Status

LIVE

https://www.imagin8.co.za/api/json/sms/R2CheckMessageStatus

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/R2CheckMessageStatus


No Description...

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
msg_id string Query Param required The Message ID passed back after sending a message

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/sms/R2CheckMessageStatus?msg_id=738299063438413824'

Response

{
    "TransactionSuccessful": true,
    "MessageID": 738283883245604864,
    "Status": "DELIVRD",
    "Code": 101,
    "DateTime": "2019-07-31 06:36:34",
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

R2 Send

LIVE

https://www.imagin8.co.za/api/json/sms/R2Send

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/R2Send


No Description...

Request   POST

Parameter Type Position # Description
Content-Type string Header Required application/json
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=

Request


$ curl -X POST -H "Content-Type: application/json" -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=" -d 
'{ "payload": { "number":"0794738299", "msg":"Testing API V2" } } 'https://www.imagin8.co.za/api/json/sandbox/sms/R2Send'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 962,
    "MessageID": 7993697,
    "MessagesSent": 1,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

R2 Send Batch

LIVE

https://www.imagin8.co.za/api/json/sms/R2SendBatch

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/R2SendBatch


No Description...

Request   POST

Parameter Type Position # Description
Content-Type string Header Required application/json
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=

Request


$ curl -X POST -H "Content-Type: application/json" -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=" -d 
'{ "payload": [ { "number": "0845039405", "msg": "Simple API Test Message for Recipient 1" }, { "number": "0794738299", "msg": "API Test Message for Recipient 2" } ] } 'https://www.imagin8.co.za/api/json/sandbox/sms/R2SendBatch'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 400,
    "Attempts": 2,
    "FailedPreCondition": 0,
    "Batch": [
        {
            "MessageID": 5167503,
            "MessagesSent": 1,
            "CellNumber": "27845039405"
        },
        {
            "MessageID": 2014432,
            "MessagesSent": 1,
            "CellNumber": "27794738299"
        }
    ],
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}