RESTful API

Phone List Guidelines

Generally when sending blasts you will need to create a recipient list. This recipient list its a file that contains the detailed information for each delivery. This file could also contain parameters for each particular case, this parameters help to customise each delivery by adding personalized information.

We have different file format depending on each case.

Basic CSV Recipient List


This file must be a text file and it which has one single column with the recipient mobile number.

Expected File's columns, if not listed it doesn't exist:

  1. Mobile Number

Text File - Sample

13056708084
18133210984

Recipient List With Parameters


All parameters on the file are optional, the only mandatory parameter it's the recipient and it has to be at the first column

This file could be either a text file or an excel one.

Expected File's columns, if not listed it doesn't exist:

  1. Mobile Number
  2. Parameter 1 {0}
  3. Parameter 2 {1}
  4. Parameter 3 {2}
  5. …

Text File - Sample

13056708084;jane;doe
18133210984;john;doe

Please be aware that we use semicolon (;) to separate fields inside the text file.

Parameters mechanism:
You may include placeholders in your message's content using {#} notation (# its a real number starting in 0), if you include them, they will be replaced for the respective column's content starting from the 2nd column in this case.

Excel File - Sample

Note that you don't have to use semicolon as separator when using excel files.

A B C
13056708084 jane doe
18133210984 john doe


SMSs Recipient List


The first 6 columns of this file are mandatory. Starting on the 7th column will be optional and must be related with the content of your message.

This file could be either a text file or an excel one.

Expected File's columns, if not listed it doesn't exist:

  1. Recipient's Mobile Number
  2. From
  3. Carrier Name
  4. Text
  5. Encoding Default UTF-8
  6. Timezone
  7. Parameter 1 {0}
  8. Parameter 2 {1}
  9. Parameter 3 {2}
  10. …

Text File - Sample

13056708084;19893653744;CarrierName;UTF-8;America/New_York;Hi {0}. Welcome to {1};Matt Ford;this test
18133210984;19893653744;CarrierName;UTF-8;America/New_York;Hi {0}. Welcome to {1};Ed Harris;this test

Please be aware that we use semicolon (;) to separate fields inside the text file.

Parameters mechanism:
You may include placeholders in your message's content using {#} notation (# its a real number starting in 0), if you include them, they will be replaced for the respective column's content starting from the 7th column in this case.

Excel File - Sample

Note that you don't have to use semicolon as separator when using excel files.

A B C D E F G H
13056708084 19893653744 CarrierName UTF-8 America/New_York Hi {0}. Welcome to {1} Matt Ford this test
18133210984 19893653744 CarrierName UTF-8 America/New_York Hi {0}. Welcome to {1} Ed Harris this test


SMSs Recipient List (simple)


Two single columns that define the recipient and the text message to send.

This file could be either a text file or an excel one.

Expected File's columns, if not listed it doesn't exist:

  1. Recipient's Mobile Number
  2. Text

Text File - Sample

13056708084;Text message for user 13056708084
18133210984;Text message for user 18133210984

Please be aware that we use semicolon (;) to separate fields inside the text file.


Excel File - Sample

Note that you don't have to use semicolon as separator when using excel files.

A B
13056708084 Text message for user 13056708084
18133210984 Text message for user 18133210984


SMSs Recipient JSON


Similar to the SMSs recipient files this will include the mobilenumber and the text for each recipient

Expected tags, if not listed it doesn't exist:

  1. mobilenumber: Recipient's Mobile Number
  2. text: The text to be sent to the recipient

Text File - Sample

[
{"mobilenumber":"00000000","text":"Test1 createBroadcastFromJson"},
{"mobilenumber":"00000001","text":"Test2 createBroadcastFromJson"}
]


Email Recipient List


The first column of this file is mandatory. Starting on the 2nd column will be optional and must be related with the content of your message.

This file could be either a text file or an excel one.

Expected File's columns, if not listed it doesn't exist:

  1. Recipient's email address
  2. Parameter 1 {0}
  3. Parameter 2 {1}
  4. Parameter 3 {2}
  5. …

Text File - Sample

matt_ford@ogangi.com;Matt Ford;April
ed_harris@ogangi.com;Ed Harris;March

Please be aware that we use semicolon (;) to separate fields inside the text file.

Parameters mechanism:
You may include placeholders in your message's content using {#} notation (# its a real number starting in 0), if you include them, they will be replaced for the respective column's content starting from the 7th column in this case.

Excel File - Sample

Note that you don't have to use semicolon as separator when using excel files.

A B C
matt_ford@ogangi.com Matt Ford April
ed_harris@ogangi.com Ed Harris March


Recipient List (with variables)


The first column of this file is mandatory. Starting on the 2nd column will be optional and must be related with the content of your message.

This file could be either a text file or an excel one.

Expected File's columns, if not listed it doesn't exist:

  1. Mobile number
  2. Parameter 1 {0}
  3. Parameter 2 {1}
  4. Parameter 3 {2}
  5. …

Text File - Sample

13056708084;Matt Ford;April
18133210984;Ed Harris;March

Please be aware that we use semicolon (;) to separate fields inside the text file.

Parameters mechanism:
You may include placeholders in your message's content using {#} notation (# its a real number starting in 0), if you include them, they will be replaced for the respective column's content starting from the 7th column in this case.

Excel File - Sample

Note that you don't have to use semicolon as separator when using excel files.

A B C
13056708084 Matt Ford April
18133210984 Ed Harris March

Segmented Recipient List


All parameters on the file are optional, the only mandatory parameter is the recipient and it has to be at the first column

This file Must contain header and could be a csv file or excel.

Expected File's columns, if not listed it doesn't exist:

  1. Mobile Number
  2. Parameter 1 {0}
  3. Parameter 2 {1}
  4. Parameter 3 {2}
  5. …

Csv File - Sample

customer_phone_num,name,city
13056708084,jane,New York
18133210984,john,New York

Please be aware that we use semicolon (,) to separate fields inside the csv file. Please read the File structure to learn more about this.

Excel File - Sample

Note that you don't have to use semicolon as separator when using excel files.

A B C
customer_phone_num name city
13056708084 jane New York
18133210984 john New York


Black List (Add Users)


Three single columns that define each user.

This file must be a text file.

Expected File's columns, if not listed it doesn't exist:

  1. Mobile Number
  2. Black List Type
  3. Comment

Text File - Sample

123456781;1;comment 1
123456782;2;other comment
123456783;3;more comment

Please be aware that we use semicolon (;) to separate fields and we use a new line for each user inside the text file.


Black List (Delete Users)


One column that define each user.

This file must be a text file.

Expected File's columns, if not listed it doesn't exist:

  1. Mobile Number

Text File - Sample

123456781
123456782
123456783

Please be aware that we use a new line for each mobile number inside the text file.


OWNCODE Recipient List


Two single columns that define the recipient and the text message to send.

This file could be either a text file or an excel one.

Expected File's columns, if not listed it doesn't exist:

  1. Recipient's Mobile Number
  2. Text to send

Text File - Sample

13056708084;Text message for user 13056708084
18133210984;Text message for user 18133210984

Please be aware that we use semicolon (;) to separate fields inside the text file.


Excel File - Sample

Note that you don't have to use semicolon as separator when using excel files.

A B
13056708084 Text message for user 13056708084
18133210984 Text message for user 18133210984