Doc Partner
SMS Partner
Doc Partner - EN
Doc Partner - EN
  • Welcome
  • API
    • SMS Partner
      • Credits
      • Send SMS
        • Single Send
        • Bulk Send
        • Send by Long Number
        • Survey Send
        • Cancel Scheduled SMS
        • Special Characters
      • Status & Statistics
        • Single Status
        • Bulk Status
        • Status by Message
        • Status by Tag
        • Sending Statistics
      • Contact Management
        • Add Group
        • Add Contact
        • Delete Group
        • Add Bulk Contacts
        • Edit Contact
        • Delete Contact
        • Get Group List
        • Get Contact List
        • Get Contact Details
      • Replies / Opt-outs Management
        • Stop List
        • Add Number to SMS Stop List
        • Remove Number from SMS Stop List
        • Replies Management
      • Sub-accounts
        • Activation
        • Create Sub-account
        • Delete Sub-account
        • Sub-account List
        • Manage Sub-account Credits
      • Manage Call Forwarding
      • Number Verification
        • Send a Verification
        • Format Verification
      • Contact Rental
        • Categories
        • Targeting & Calculation
        • Rental Status
        • Download File
      • RCS
    • Error Codes
Powered by GitBook

© 2025 NDA Media

On this page
  1. API
  2. SMS Partner

Credits

This request is used to retrieve your available SMS credits, as well as the number of pending outgoing SMS.

URL

GET https://api.smspartner.fr/v1/me

Required Parameters

Name
Value

apiKey

Optional Parameters

Name
Value

_format

json or xml

Requests

<?php
    // Prepare data for GET request
    $data = 'apiKey=YOUR_API_KEY';

    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/me?'.$data);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($curl, CURLOPT_TIMEOUT, 10);

    $result = curl_exec($curl);
    curl_close($curl);

    // Process your response here
    echo $result;
?>
' VB.NET code (same as original, no translation needed)
# Python code (same as original, no translation needed)
curl -H "Content-Type: application/json" -X GET  https://api.smspartner.fr/v1/me?apiKey=xxx
// Node.js code (same as original, no translation needed)
// Java code (same as original, no translation needed)
// Swift code (same as original, no translation needed)
// Go code (same as original, no translation needed)
// C# code (same as original, no translation needed)

Response

{
    "success": true,
    "code": 200,
    "user": {
        "username": "exemple@email.com",
        "firstname": "John",
        "lastname": "Doe"
    },
    "credits": {
        "creditSms": 269082,
        "creditSmsECO": 444570,
        "creditHlr": 2045023,
        "toSend": 0,
        "solde": "10225.119",
        "currency": "EUR",
        "balance": "10225.119"
    }
}
<?xml version='1.0' encoding='UTF-8'?>
<result>
    <entry>true</entry>
    <entry>200</entry>
    <entry>
        <username>exemple@email.com</username>
        <firstname>John</firstname>
        <lastname>Doe</lastname>
    </entry>
    <entry>
        <entry>269070</entry>
        <entry>444551</entry>
        <entry>2044937</entry>
        <entry>0</entry>
        <entry><![CDATA[10224.688]]></entry>
        <entry><![CDATA[EUR]]></entry>
        <entry><![CDATA[10224.688]]></entry>
    </entry>
</result>

Error Codes

Response Code
Message

10

Invalid API key

200

Everything went fine!

PreviousSMS PartnerNextSend SMS

Last updated 1 month ago

Your API key