Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The response is a JSON object with the following attributes: 

 

addressThe device phone number
timestampLast location timestamp
latitudeDevice network location latitude
longitudeDevice network location longitude
altitudeDevice network location altitude / elevation
accuracyDevice network location accuracy (in meters)
 

Sample Call

curl --silent https://api.us.apiconnect.ibmcloud.com/tmforum-apidev/telustmfcatalog/telustmfapilocation/location/6045550000 \
  -H "Content-type: application/json" \
  -H "X-IBM-Client-Id: c466530c-8489-4353-8cac-6c0babe8ff40"

...

{
"address": "6045550000",
"timestamp": "Mon, 18 Sep 2017 03:39:36 +0000",
"latitude": "49.237774",
"longitude": "-123.017636",
"altitude": "22.0",
"accuracy": "182"
}

 

Error Messages

Client id is missingClient credentials are missing (HTTP header X-IBM-Client-Id is missing)
Client id not registeredClient credentials are invalid (invalid value for HTTP header X-IBM-Client-Id)
Missing terminal addressAddress / phone number parameter is missing
Terminal address not authorizedAddress / phone number is not whitelisted for use by your application

...

This service is to be used to retrieve the delivery status of an SMS message you previously sent.

REST API

 GET https://api.us.apiconnect.ibmcloud.com/tmforum-apidev/telustmfcatalog/telustmfapistatussms/status/{correlator}

Where {correlator} is the correlator ID returned from a successful SMS delivery API call.

...