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 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 sending SMS using Alcodes API, you need:

  1. API keys that can be generated through Alcodes's dashboard.
  2. Password for every account is passwd.
  3. There is no IP restrictions as now.

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 Code Where messages will be delivered. For example IN for India. Refer Country List (in left menu) for list of country codes


smsSenderId

String

Sender Id for Message


smsTypeId

String

Type of Message

  • 1: Normal Sms
  • 2: Flash Sms
  • 3: Unicode Sms
  • 4: Unicode + Flash Sms

otp

boolean

true for OTP message, default false

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

Note: Please replace [API_KEY] with your actual Api Key.

							/**
							*	Request Sample
							*/								
							curl -X POST 
							http://www.alcodes.com/api/sms-compose --user [API_KEY]:passwd  
							-H 'Cache-Control: no-cache' -H 'content-type: multipart/form-data' 
							-F countryCode=IN -F smsSenderId=AUTHMS -F is_otp=true -F message=test-sms 
							-F phoneNumbers=8058220122 -F smsTypeId=1
							
							/**
							** Api Reponse
							*/
							{
							  "status": "success",
							  "data": {
							    "invalidMobileNumbers": [],
							    "msgid": {
							      "8058220122": 36
							    }
							  },
							  "error": null,
							  "payload": null
							}
						
					

GET/api/sms-compose

Compose New Sms Campaign


Note: Please replace [API_KEY] with your actual Api Key.

						   /**
							*	Request Sample
							*/							
							curl -X GET 
							http://www.alcodes.com/api/sms-compose?
							message=test+sms&phoneNumbers=8058220122&countryCode=IN&smsSenderId=AUTHMS&smsTypeId=1&otp=true&async=true
							&username=[API_KEY]&password=passwd
							
							/**
							** Api Reponse
							*/
							{
							  "status": "success",
							  "data": {
							    "invalidMobileNumbers": [],
							    "msgid": {
							      "8058220122": 36
							    }
							  },
							  "error": null,
							  "payload": null
							}
						
					

GET/api/user-balance

Retrive User Current Credit Balance


This endpoint is used for retrieving User Credit Balance.

Note: Please replace [API_KEY] with your actual Api Key.

							/**
							*	Request Sample
							*/
							curl -X GET 
							http://www.alcodes.com/api/user-balance --user [API_KEY]:passwd  
							-H 'content-type: multipart/form-data'
						    
						    /**
						     * 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.

Note: Please replace [API_KEY] with your actual Api Key.

							/**
							*	Request Sample
							*/
							curl -X GET 
							http://www.alcodes.com/api/user/senderid/list --user [API_KEY]:passwd  
							-H 'content-type: multipart/form-data'
							
						    /**
						     ** 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.

Note: Please replace [API_KEY] with your actual Api Key.

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