Getting Started with Alcodes

With this page you will get started with Alcodes. In no time, you'll be up and running on the dot!


Introduction to Alcodes Api

Alcodes’s API welcomes you! You can use this API for authorizing, composing new Sms Campaign as well as for getting information of previous Sms Campaigns.

For now, we have language bindings in cURL, Java, .NET, PHP, Python, Ruby and Node. We do provide cURL examples and these examples can be used in other languages if and when required. You can view the code examples in the dark area which is appearing in the right side of the window.


Getting Started

To start accepting payments using Razorpay, you need:

  1. API keys that can be generated through Razorpay's dashboard
  2. Checkout form integrated in your website / app
  3. Payment capturing process in your backend

The process of accepting payments from your end customers is as follows:

  1. Users click on a pay button and are shown the Checkout Form
  2. User fills his/her payment details and Authorizes the payment.
  3. Checkout Form hands over to you the razorpay_payment_id
  4. Your server side backend uses the razorpay_payment_id to capture the payment
  5. You get the money in your bank account in T+3 days.

The capture process is required to ensure that the correct amount has been charged to the user. In case you don't want to or cannot implement the capture process in your server side backend, you can also manually capture the payments from our dashboard. There's a section below on Payment Flow which explains the stages in a payment like Authorize and Capture.

Note that if you want to enable auto-capture of payment immediately after authorization, then that can be done via integration of Orders API.

To integrate the Checkout Form in your website, read the section below for the integration details. For mobile devices, read the section on Android and iOS SDK.

For the capture process, you can either use the Libraries & Integrations that we have provided for various frameworks and languages, or you could directly query the API for this.

Authentication


All server side requests like Comopse Sms Campaign, getting details of previous Sms Campaigns must be authenticated with basic auth using the Api Key as username.

POST/api/sms-compose

Compose New Sms Campaign


Query Params

message

String

Message To Send


phoneNumbers

Comma seprated mobile numbers without country code.

Mobile numbers List


countryCode

String

Country Where messages will be delivered.


smsSenderId

String

Sender Id for Message


otp

boolean

true for otp message, default false


async

boolean

true if want to get message id's for mobile numbers, false otherwise. Default false

This endpoint is used for Compose New Sms Campaign based on optional parameter.

							/**
							*	Request Sample
							*/
						    POST /web/api/sms-compose HTTP/1.1
							Host: local.alcodes.com:8080
							Content-Type: application/x-www-form-urlencoded
							Authorization: Basic NmZlZTQyNzgtMzE1Ni00NGI0LWE1MGEtMjg4NTVjNTg4Mzk1OnBhc3N3ZA==
							Cache-Control: no-cache
							Postman-Token: 4d0362ee-fb25-58a1-fb1c-9545afcad33a
							message=test+sms&phoneNumbers=9571716534%2C8104893801&countryCode=IN&smsSenderId=TESTAP&otp=true&async=true
							
							/**
							** async(false) Reponse
							*/
							{
							  "status": "success",
							  "data": {
							    "invalidMobileNumbers": [],
							    "msgid": {
							      "9571716534": 37,
							      "8104893801": 36
							    }
							  },
							  "error": null,
							  "payload": null
							}
							
							/**
							** async(true) Response
							*/
							{
							  "status": "success",
							  "data": {
							    "validMobileNumbers": [
							      "8104893801",
							      "9571716534"
							    ]
							  },
							  "error": null,
							  "payload": null
							}
						

GET/api/user-balance

Retrive User Current Credit Balance


This endpoint is used for retrieving User Credit Balance.

						    /**
						     * Api Response
						     */
						    {
							  "status": "success",
							  "data": 100,
							  "error": null,
							  "payload": null
							}
						

post/api/user/senderid/list

Retrive Sender Id List


This endpoint is used for retrieving list of User Sender Ids.

						    /**
						     ** Api Response
						     */
						    {
							  "status": "success",
							  "data": [
							    {
							      "id": 2,
							      "user": null,
							      "senderKey": "TESTAP",
							      "file": null,
							      "type": "TRAN",
							      "requestedAt": 1493192142000,
							      "approvedAt": 1493192160000,
							      "status": "approved",
							      "countryCode": "IN"
							    }
							  ],
							  "error": null,
							  "payload": null
							}
					

post/api/user/groups

Retrive User Group List


This endpoint is used for retrieving list User Groups created by user

						    /**
						     ** Api Response
						     */
						    {
							  "status": "success",
							  "data": [
							    {
							      "id": 3,
							      "name": "alcodes",
							      "countryCode": "IN",
							      "mobileNumberCount": 355887,
							      "groupEmpty": false
							    }
							  ],
							  "error": null,
							  "payload": null
							}
						

Country List

List countries with their respective country code


Country Code
Kenya KE
Gambia GM
Poland PL
New Caledonia NC
Abkhazia AM
Honduras HN
Singapore SG
Monaco MC
Algeria DZ
Netherlands NL
Suriname SR
Lebanon LB
Italy IT
Brazil BR
Chad TD
Mexico MX
Guadeloupe GP
Serbia RS
Somalia SO
Yemen YE
Switzerland CH
New Zealand NZ
Colombia CO
Denmark DK
Malaysia MY
Venezuela VE
Macau MO
Egypt EG
Nigeria NG
Bangladesh BD
Uruguay UY
French Polynesia PF
Reunion RE
Fiji FJ
Congo CG
South Africa ZA
Cayman Islands KY
Bahamas BS
Rwanda RW
Paraguay PY
Macedonia MK
Norway NO
Sao Tome and Principe ST
Australia AU
Haiti HT
Togo TG
Lesotho LS
Uzbekistan UZ
Uganda UG
Tajikistan TJ
Senegal SN
Namibia NA
Grenada GD
Belgium BE
Jordan JO
Antigua and Barbuda AG
Trinidad and Tobago TT
Gabon GA
United Kingdom GB
Panama PA
Canada CA
Guernsey GG
Ethiopia ET
Saint Vincent and the Grenadines VC
Liberia LR
Luxembourg LU
Turkey TR
Vietnam VN
Benin BJ
Djibouti, Republic of DJ
Zambia ZM
Indonesia ID
Turkmenistan TM
Norfolk Island NF
Liechtenstein LI
Angola AO
Barbados BB
San Marino SM
British Indian Ocean Territory IO
Argentina AR
Taiwan TW
Kazakhstan KZ
Morocco MA
Hungary HU
Jersey JE
Pakistan PK
Bermuda BM
Iran IR
Spain ES
El Salvador SV
Dominica, Commonwealth of DM
Botswana BW
Aruba AW
Nicaragua NI
Bhutan BT
Portugal PT
Guinea GN
Germany DE
Hong Kong HK
Philippines PH
Thailand TH
Malta MT
Finland FI
United States US
Costa Rica CR
Guinea-Bissau GW
United Arab Emirates AE
Gibraltar GI
Jamaica JM
Solomon Islands SB
French Guiana GF
Sierra Leone SL
Palau PW
Czech Republic CZ
Mali ML
Maldives MV
Bahrain BH
Afghanistan AF
Libya LY
Bulgaria BG
Equatorial Guinea GQ
Lithuania LT
Martinique MQ
Sint Maarten SX
Madagascar MG
Faroe Islands FO
Isle of Man IM
Wallis and Futuna Islands WF
Guatemala GT
Brunei Darussalam BN
Oman OM
Cyprus CY
Austria AT
Mongolia MN
Dominican Republic DO
Ireland IE
Slovakia SK
Mauritius MU
Chile CL
Qatar QA
Saudi Arabia SA
Burundi BI
Tunisia TN
Greenland GL
Ecuador EC
Cook Islands CK
Guyana GY
Bolivia BO
Kyrgyzstan KG
Azerbaijan AZ
Turks and Caicos Islands TC
India IN
Seychelles SC
Nepal NP
Burkina Faso BF
Central African Republic CF
Marshall Islands MH
Zimbabwe ZW
Peru PE
American Samoa AS
Montserrat MS
Russian Federation RU
Georgia GE
Cambodia KH
Cuba CU
Romania RO
Myanmar MM
Swaziland SZ
Saint Lucia LC
Latvia LV
Ghana GH
Iceland IS
Albania AL
Japan JP
Comoros KM
Samoa WS
Niger NE
Greece GR
Andorra AD
Israel IL
Montenegro ME
China CN
Sudan SD
Estonia EE
Belize BZ
Nauru NR
Anguilla AI
France FR
Bosnia and Herzegovina BA
Malawi MW
Saint Kitts and Nevis KN
Cape Verde CV
Cameroon CM
Tonga TO
Sri Lanka LK
Belarus BY
Sweden SE
Ukraine UA
Mozambique MZ
Kuwait KW
Vanuatu VU
Papua New Guinea PG