square-poll-verticalRental Status

This request allows you to retrieve the status of a contact rental.

URL

GET https://api.smspartner.fr/v1/location/status

Parameters

Name
Value

token

Rental identifier.

Requests

<?php
 
        // Prepare data for GET request
        $data = 'apiKey=YOUR_API_KEY&token=xxx';
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/location/status?'.$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;
?> 

Response

Errors

Rental status codes

Response Code
Message

0

The rental request has been made

1

File is being generated

2

File is ready. You can download it.

3

The rental request failed

5

File has already been downloaded

Error codes

Response Code
Message

1

API key is required

10

Invalid API key

31

Rental token is required

32

Rental not found

200

Everything went well!

Last updated