### Check Credit API Source: https://www.budgetsms.net/sms-http-api/check-credit Fetches the current credit balance in your BudgetSMS account. ```APIDOC ## GET /checkcredit/ ### Description This endpoint retrieves the current credit balance of your BudgetSMS account. ### Method GET ### Endpoint https://api.budgetsms.net/checkcredit/ ### Parameters #### Query Parameters - **username** (Alphanumeric) - Required - Your BudgetSMS username. - **userid** (Numeric) - Required - Your BudgetSMS user ID. - **handle** (Alphanumeric) - Required - Your BudgetSMS handle. ### Request Example ``` https://api.budgetsms.net/checkcredit/?username=user1&userid=21547&handle=1e753da74 ``` ### Response #### Success Response (200) - **credit** (Numeric) - The current credit balance in your account. #### Response Example ```json { "credit": 1000 } ``` ``` -------------------------------- ### Account Pricing API Source: https://www.budgetsms.net/sms-http-api/account-pricing This API endpoint allows you to fetch the current pricing details associated with your BudgetSMS account. The pricing information is returned in JSON format. ```APIDOC ## GET /getpricing/ ### Description Fetches the current pricing in your account and returns it in JSON formatting. ### Method GET ### Endpoint https://api.budgetsms.net/getpricing/ ### Parameters #### Query Parameters - **username** (Alphanumeric) - Required - BudgetSMS username - **userid** (Numeric) - Required - BudgetSMS userid - **handle** (Alphanumeric) - Required - BudgetSMS handle ### Request Example ``` https://api.budgetsms.net/getpricing/?username=user1&userid=21547&handle=1e753da74 ``` ### Response #### Success Response (200) - **pricing** (object) - Contains pricing details for various services. #### Response Example ```json { "pricing": { "sms": { "nl": "0.01", "be": "0.01", "fi": "0.01", "fr": "0.01", "mt": "0.01", "tr": "0.01", "de": "0.01", "es": "0.01", "lv": "0.01", "bg": "0.01", "se": "0.01", "dk": "0.01", "it": "0.01", "bf": "0.01", "at": "0.01", "gb": "0.01", "no": "0.01", "jp": "0.01", "ie": "0.01", "ch": "0.01" } } } ``` ``` -------------------------------- ### Send SMS API Source: https://www.budgetsms.net/sms-http-api/send-sms This endpoint allows you to send SMS messages using your BudgetSMS account credentials. You can also retrieve pricing, country/operator information, and your remaining credit balance by including specific parameters. ```APIDOC ## GET /sendsms/ ### Description Sends an SMS message to a specified recipient using the BudgetSMS API. ### Method GET ### Endpoint https://api.budgetsms.net/sendsms/ ### Parameters #### Query Parameters - **username** (Alphanumeric) - Required - BudgetSMS username. - **userid** (Numeric) - Required - BudgetSMS userid. - **handle** (Alphanumeric) - Required - BudgetSMS handle. - **msg** (Alphanumeric) - Required - The content of the SMS message. - **from** (Alphanumeric or Numeric) - Required - The sender ID for the SMS message. - **to** (Numeric) - Required - The recipient's MSISDN (mobile number) in E.164 format (e.g., 31612345678). - **customid** (Alphanumeric) - Optional - A unique identifier for the message, ensuring it is sent only once. - **price** (1 or 0) - Optional - If set to 1, the response will include the number of SMS parts and the total price. - **mccmnc** (1 or 0) - Optional - If set to 1, the response will include the destination Mobile Country Code (MCC) and Mobile Network Code (MNC). - **credit** (1 or 0) - Optional - If set to 1, the response will include the remaining account credit. ### Request Example ```json { "username": "user1", "userid": "21547", "handle": "1e753da74", "msg": "This is example content", "from": "BudgetSMS", "to": "31612345678", "customid": "1324513254", "price": 1, "mccmnc": 1, "credit": 1 } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the status of the request (e.g., "1" for success). - **messageid** (string) - A unique identifier for the sent message. - **price** (string) - The cost of the sent message (if `price=1`). - **parts** (string) - The number of SMS parts the message was split into (if `price=1`). - **credit** (string) - The remaining account credit (if `credit=1`). - **mcc** (string) - Mobile Country Code of the recipient (if `mccmnc=1`). - **mnc** (string) - Mobile Network Code of the recipient (if `mccmnc=1`). #### Response Example ```json { "status": "1", "messageid": "67890", "price": "0.05", "parts": "1", "credit": "9.95", "mcc": "204", "mnc": "08" } ``` ``` -------------------------------- ### Test SMS API Source: https://www.budgetsms.net/sms-http-api/test-sms This endpoint is used to simulate sending an SMS message for testing purposes. It does not deduct credits or send actual messages. The response can include details about message pricing, country/operator information, and account credit. ```APIDOC ## GET /testsms/ ### Description This endpoint simulates sending an SMS message for testing purposes without deducting credits or sending actual messages. It allows you to verify API integration and response formats. ### Method GET ### Endpoint https://api.budgetsms.net/testsms/ ### Parameters #### Query Parameters - **username** (Alphanumeric) - Required - Your BudgetSMS username. - **userid** (Numeric) - Required - Your BudgetSMS userid. - **handle** (Alphanumeric) - Required - Your BudgetSMS handle. - **msg** (Alphanumeric) - Required - The content of the SMS message. - **from** (Alphanumeric or Numeric) - Required - The sender ID for the SMS message. - **to** (Numeric) - Required - The recipient's MSISDN (mobile number) in E.164 international format (e.g., 31612345678). - **customid** (Alphanumeric) - Optional - A unique identifier for the message, ensuring it can only be used once. - **price** (1 or 0) - Optional - If set to 1, the response will include the number of SMS parts and the total price. - **mccmnc** (1 or 0) - Optional - If set to 1, the response will include the destination Mobile Country Code (MCC) and Mobile Network Code (MNC). - **credit** (1 or 0) - Optional - If set to 1, the response will include the remaining account credit. ### Request Example ``` https://api.budgetsms.net/testsms/?username=user1&userid=21547&handle=1e753da74&msg=This+is+example+content&from=BudgetSMS&to=31612345678&price=1&credit=1 ``` ### Response #### Success Response (200) - **status** (string) - Indicates the status of the test send (e.g., "OK"). - **parts** (integer) - The number of SMS parts the message consists of (only if price=1). - **price** (float) - The total price of the message (only if price=1). - **credit** (float) - The remaining account credit (only if credit=1). - **mcc** (string) - The Mobile Country Code of the destination (only if mccmnc=1). - **mnc** (string) - The Mobile Network Code of the destination (only if mccmnc=1). #### Response Example ```json { "status": "OK", "parts": 1, "price": 0.03, "credit": 10.50, "mcc": "204", "mnc": "08" } ``` ``` -------------------------------- ### Push DLR Notification Source: https://www.budgetsms.net/sms-http-api/push-dlr BudgetSMS will send a POST request to your specified push URL with DLR status updates for sent SMS messages. ```APIDOC ## POST /push/dlr ### Description This endpoint is not directly called by the user. Instead, BudgetSMS sends DLR notifications to this URL when the status of a sent SMS message changes. ### Method POST ### Endpoint Your configured push URL ### Parameters #### Query Parameters - **id** (Numeric) - Required - The unique identifier for the SMS message. - **status** (Numeric) - Required - The current status of the message. Refer to 'DLR Status' documentation for possible values. - **date** (Unix timestamp) - Required - The timestamp when the status update occurred. ### Request Example (BudgetSMS will send this to your server) ```json { "id": "25745294", "status": "1", "date": "1484407297" } ``` ### Response (Your server should respond to acknowledge receipt) #### Success Response (200 OK) BudgetSMS expects a 200 OK response to confirm that the DLR notification was received. #### Response Example (Your server's response) ```json { "message": "DLR received successfully" } ``` ``` -------------------------------- ### HLR API Endpoint Source: https://www.budgetsms.net/sms-http-api/hlr This endpoint allows you to fetch detailed information on mobile numbers worldwide by providing subscriber details. ```APIDOC ## GET /hlr/ ### Description This endpoint allows you to fetch detailed information on mobile numbers worldwide. It will return the actual MCC and MNC of a subscriber. This will also work with subscribers who are ported to another operator. ### Method GET ### Endpoint https://api.budgetsms.net/hlr/ ### Parameters #### Query Parameters - **username** (Alphanumeric) - Required - BudgetSMS username - **userid** (Numeric) - Required - BudgetSMS userid - **handle** (Alphanumeric) - Required - BudgetSMS handle - **to** (Numeric) - Required - Subscriber msisdn to check. Format: Include country prefix, omit trailing local 0. Example for Netherlands (+31) mobile 06-12345678: `31612345678` ### Request Example ``` https://api.budgetsms.net/hlr/?username=user1&userid=21547&handle=1e753da74&to=31612345678 ``` ### Response #### Success Response (200) - **status** (string) - The status of the HLR request. - **message** (string) - A descriptive message about the HLR request result. - **hlr** (object) - Contains HLR information if successful. - **imsi** (string) - International Mobile Subscriber Identity. - **mcc** (string) - Mobile Country Code. - **mnc** (string) - Mobile Network Code. - **operatormame** (string) - The name of the operator. - **lac** (string) - Location Area Code. - **cellid** (string) - Cell ID. - **portstatus** (string) - Indicates if the number has been ported. - **active** (string) - Indicates if the number is active. #### Response Example ```json { "status": "success", "message": "HLR lookup successful.", "hlr": { "imsi": "123456789012345", "mcc": "204", "mnc": "04", "operatormame": "Vodafone NL", "lac": "1234", "cellid": "5678", "portstatus": "0", "active": "1" } } ``` ``` -------------------------------- ### Pull DLR API Source: https://www.budgetsms.net/sms-http-api/pull-dlr Fetches the DLR status for a single SMS message sent via the HTTP API. While possible, using Push DLR is the recommended method for DLR notifications. ```APIDOC ## GET /checksms/ ### Description This endpoint allows you to retrieve the Delivery Receipt (DLR) status for a specific SMS message using its unique ID. ### Method GET ### Endpoint https://api.budgetsms.net/checksms/ ### Parameters #### Query Parameters - **username** (string) - Required - Your BudgetSMS username. - **userid** (string) - Required - Your BudgetSMS user ID. - **handle** (string) - Required - Your BudgetSMS handle. - **smsid** (string) - Required - The unique identifier for the SMS message whose DLR status you want to retrieve. This ID is provided in the response when sending an SMS via the HTTP API. ### Request Example ``` https://api.budgetsms.net/checksms/?username=user1&userid=21547&handle=1e753da74&smsid=64354593 ``` ### Response #### Success Response (200) - **status** (string) - The DLR status of the SMS message (e.g., 'delivered', 'failed', 'pending'). - **error** (string) - An error message if the request failed. #### Response Example ```json { "status": "delivered", "error": null } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.