Integration

API Doc's

Sample Codes with Exclusive Documentation

Introduction

API Reference - v2.0

Your API Key is : [YOUR_API_KEY]

For Generate / Re-Generate API Key goto to Dashboard/My Account

Authentication
POST Method : authorization: Bearer [YOUR_API_KEY] (in header)
GET Method : ?api_key=[https://obligr.io/api_v2/] (in QueryString url)

Edit
Edit
Edit

BODY PARAMS

Key
Value
Description
username (string)
DEMOABCD
REQUIRED
company_name (string)
OBLIGR INDIA PVT LTD
REQUIRED
attn (string)
OBLIGR
REQUIRED
address (string)
20/3 SAJAN NAGAR
REQUIRED
pincode (number)
452001
REQUIRED - 6 DIGIT
city (string)
INDORE
REQUIRED
state (string)
MADHYA PRADESH
REQUIRED
country (string)
INDIA
REQUIRED
gst_number (string)
23AACC06906C1ZV
REQUIRED - 15 Characters
gst_code (number)
23
REQUIRED - 2 DIGIT
pan_number (string)
AACC06906C
REQUIRED - 10 Characters
Edit

BODY PARAMS

Key
Value
Description
name (string)
DEMOABCD
REQUIRED
username (string) Only characters or number, not space or special characters
DEMOABCD
REQUIRED
email (string)
REQUIRED
mobile_no (number) 10 Digit only
0000012345
REQUIRED
Edit

BODY PARAMS

Key
Value
Description
username (string)
DEMOABCD
REQUIRED
credit_type (string)
sms
REQUIRED sms , voice
credit (number)
20
REQUIRED
service_type (string)
Transactional
REQUIRED Transactional,Promotional,open_dnd,voice_call
price_per_credit (number)
0.20
REQUIRED
Edit
Edit

BODY PARAMS

Key
Value
Description
username (string)
DEMOABCD
REQUIRED
Edit

BODY PARAMS

Key
Value
Description
mobile_number (string)(string)
08225838383,918225848484,+918225838383
REQUIRED
Edit
Edit

BODY PARAMS

Key
Value
Description
message (string)
THIS IS A TEST MESSAGE
REQUIRED
unicode (boolean)
0
1 or 0
Edit

BODY PARAMS

Key
Value
Description
sender_id
OBLIGR
REQUIRED - 6 Character.
message (string)
THIS IS A TEST MESSAGE
REQUIRED
mobile_no (string)
8225838383
REQUIRED -comma separate multiple mobile no
schedule_date_time (datetime)
2020-05-20 13:44:43
User posting_time for Schedule SMS. Format : 'Y-m-d H:i:s'
unicode (boolean)
0
1 or 0 Unicode 1 SMS Count = 70 Characters
Edit

BODY PARAMS

Key
Value
Description
date_from (string)
2020-07-29 00:00:00
REQUIRED Y-m-d h:i:s Format
date_to
2020-07-29 23:59:59
REQUIRED Y-m-d h:i:s Format
sender_id (string)
OBLIGR
message (string)
THIS IS A TEST MESSAGE
job_id (number)
2984201
Note : if search by "job_id" then no need to enter date_from or date_to.
Edit

BODY PARAMS

Edit

BODY PARAMS

Edit

BODY PARAMS

Key
Value
Description
sender_id (string)
DEMOOO (string)
REQUIRED - 6 Character.
message (string)
THIS IS A TEST MESSAGE IT SHOULD BE ABOVE 160 CHARACTER PLEASE TYPE 160 CHARACTER FOR APPROVE THIS SENDER ID
REQUIRED sample message
Edit

BODY PARAMS

Edit
Edit

Two Factor Authentication process - it should be a single service with different option

BODY PARAMS

Key
Value
Description
caller_id (number)
8225838383
REQUIRED 10 Digit mobile number.
voice_source (string)
voice_file
Optional voice_file or voice_text
voice_file (string)
REQUIRED IF use voice_source is voice_file file name or file_url only .wav,.mp3 file
voice_text (string)
REQUIRED IF use voice_source is voice_text
voice_pitch_rate (string)
medium
Optional slow,medium,fast

voice_name

REQUIRED IF use type is voice_call/both

Voice Name

Language - Gender

Salli

en-US - Female

Joey

en-US - Male

Aditi

hi-IN - Female - 1

Raveena

hi-IN - Hindi Text Accepted

mobile_no
8225838383
REQUIRED comma separate multiple mobile no
posting_time (datetime)
2020-05-22 15:40:22
User posting_time for Schedule Voice Call. Format : 'Y-m-d H:i:s'
is_conversation (integer)
(integer) 1 OR 0
Track call response after call press by user.
re_schedule_time (integer)
Default 0
Number of time auto Reschedule
re_schedule_status (string)
Answered,NoAnswer,Failed,Busy,RING_TIMEOUT,Rejected,Completed
voice_interval (integer)
Reschedule Time Interval (In Minutes).
country_code (string)
(string) eg.IN (default)
Select country if you want to sent International Call(Outside India).
+267 - Botswana (+267)
+86 - China (+86)
+49 - Germany (Germany) (+49)
+30 - Greece (Greece) (+30)
+62 - Indonesia (Indonesia) (+62)
+964 - Iraq (+964)
+39 - Italy (+39)
+60 - Malaysia (Malaysia) (+60)
+960 - Maldives (Maldives) (+960)
+230 - Mauritius (Mauritius) (+230)
+52 - Mexico (Mexico) (+52)
+95 - Myanmar (Myanmar) (+95)
+977 - Nepal (Nepal) (+977)
+64 - New Zealand (New Zealand) (+64)
+234 - Nigeria (Nigeria) (+234)
+968 - Oman (Oman (+968)
+63 - Philippines (Philippines) (+63)
+7 - Russian Federation (Russian Federation) (+7)
+65 - Singapore (Singapore) (+65)
+66 - Thailand (+66)
+971 - United Arab Emirates (United Arab Emirates) (+971)
+44 - United Kingdom (United Kingdom) (+44)
+1 - United States (+1)
Edit

BODY PARAMS

Key
Value
Description
sender_id (string)
TESTING
Name or title for Caller ID
mobile_no (number)
8225838383
REQUIRED 10 digit mobile number
Edit
Key
Value
Description
verify_otp
REQUIRED
Edit
Edit

BODY PARAMS

Key
Value
Description
date_from (string)
2020-07-28 00:00:00
REQUIRED Y-m-d h:i:s Format
date_to (string)
2020-07-28 23:59:59
REQUIRED Y-m-d h:i:s Format
campaign_id (number)
556093
Note : if search by "campaign_id" then no need to enter date_from or date_to.

answered: The destination has answered the call
rejected: The call attempt was rejected by the destination
busy: The destination is on the line with another caller
unanswered: The call was canceled by the caller
timeout: The call timed out before it was answered
failed: The call failed before reaching the destination
completed: The call is  completed successfully

Edit
Edit
Edit

BODY PARAMS

Key
Value
Description
voice_title (string)
voice_file (string)
REQUIRED voice_file URL or form_data file
Edit
Edit
Edit

Two Factor Authentication process - it should be a single service with different option

BODY PARAMS

Key
Value
Description
mobile_no (number)
REQUIRED 10 Digit mobile number.
type (string)
sms
Optional
sms,voice_call,both Default is : sms
if select 'both' then otp verification
goes to sms as well voice call.
sender_id (string)
BLKSMS
Optional
Usee in Type is sms/both. Select
from your active sender ID.
caller_id (string)
REQUIRED IF use type is voice_call/both
10 Digit Mobile number.
Select from your active Caller ID.
voice_name (string)
sms
REQUIRED IF use type is voice_call/both
message (string)
Your OTP Verification Code is : ##OTP##
optional
Type your custom message.put OTP code replace placeholder : ##OTP##.
Default is : Your OTP Verification Code is : ##OTP##
Here ##OTP## is replace with auto generate OTP .
expire_time (number)
180
Optional
Give value in minutes Default is : 180 (for 3 hours)
otp_length (number)
6
Optional
length of OTP number in (DIGIT) Default is : 6 Digit Min Value is : 4 , Max Value is : 12
is_unicode (int)
0
Optional 1 or 0

voice_name

REQUIRED IF use type is voice_call/both

Voice Name

Language - Gender

Salli

en-US - Female

Joey

en-US - Male

Aditi

hi-IN - Female - 1

Raveena

hi-IN - Hindi Text Accepted

Edit

BODY PARAMS

Key
Value
Description
mobile_no (number)
8225838383
REQUIRED 10 digit mobile number
verify_key (string)
HOElx46H
REQUIRED
Edit

BODY PARAMS

Key
Value
Description
mobile_no (number)
8225838383
REQUIRED 10 digit mobile number
verify_key (string)
HOElx46H
REQUIRED
otp (string)
******
REQUIRED Your 6 Digit OTP Code.