registration/claim_credits

Allows a user to claim the free credits that was given to him upon registration.

Example

https://www1.bulksms.com/eapi/registration/claim_credits/1/1.0/?username=john&password=abcd1234&registration_code=AB3FJ7

Required parameters

• username
• password
• registration_code: the code that was sent to the user’s mobile upon registration.

Returns:

status_code|status_description

e.g.

0|Credits claimed successfully

Possible values for status_code are:

• 0: Success
• 22: Internal fatal error
• 23: Authentication failure
• 24: Data validation failed (e.g. your token format is invalid)
• 40: Temporarily unavailable
• 100: Token invalid
• 101: Token already claimed

You should never depend on the value of status_description - only depend on status_code, which is a constant. However, status_description can contain useful information about the nature of failures when you are developing your initial application.

Note: you should attempt to resend if you receive status code 40. All other errors should be considered fatal.

Any HTTP status code other than 200 should be considered transient, i.e. you should attempt to resend after some interval.

URL

The current URL is:

https://www[12].bulksms.com/eapi/registration/claim_credits/1/1.0/

(please also read the notes on versioning)

ChangeLog

• 19-Aug-2004
  • Version 1.0.