Bell Developer Portal

Developer Portal

Device

Notification

Back

Device API

Released on Apr-16-2021

Bell version: v0.8.2

Last updated: Jun-25-2021

Open API

Overview
Get device details
Get Latest Device Location
Get Device Location History

Business overview

This API gives the details and low accuracy location of Non-GPS IoT devices that connect to the Bell wireless LTE/LTE-M network.

Get device details

Path

GET /devices

Parameters

imsi		The IMSI(s) of the device(s). The IMSI ( International Mobile Subscriber Identity ) is defined by the [E.212 standard](https://www.itu.int/rec/T-REC-E.212/en).
Optional in Query		302690000000000
string

msisdn		The phone number(s) associated with the device(s). The MSISDN ( Mobile Station International Subscriber Directory Number ) is defined by the [E.164 standard](https://www.itu.int/rec/T-REC-E.164-201011-I/en).
Optional in Query		11234567890
string

correlationId		This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
Optional In Header
string

Accept		application/json
Optional in header
string

Response

200

Device Details

{
  "msisdn": "11234567890",
  "imsi": "302690000000000",
  "iccid": "12345678901234567890",
  "status": "Active",
  "operator": "Bell",
  "dcp": "Ericsson",
  "label": "Test Device",
  "companyId": "00000001",
  "companyName": "Company-1"
}

204

None of the devices is found

400

Bad Request

{
  "type": "https://api.iot.bell.ca/validation-error",
  "title": "The request is invalid",
  "instance": "/devices?imsi=301690000000000",
  "detail": "The 'imsi' is invalid: it should be a number 
  that starts with '302' and is followed by 12 digits"
}

401

The customer can't access this information for one of the following reasons: * the customer doesn't have access to this API: no `device-details` scope * none of the devices belongs to the customer

403

The customer can't be authenticated because the JWT token is invalid

500

Internal Server Error

Get Latest Device Location

Path

GET /devices/locations

Parameters

imsi		The IMSI(s) of the device(s). The IMSI ( International Mobile Subscriber Identity ) is defined by the [E.212 standard](https://www.itu.int/rec/T-REC-E.212/en).
Optional in Query		302690000000000
string

msisdn		The phone number(s) associated with the device(s). The MSISDN ( Mobile Station International Subscriber Directory Number ) is defined by the [E.164 standard](https://www.itu.int/rec/T-REC-E.164-201011-I/en).
Optional in Query		11234567890
string

correlationId		This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
Optional In Header
string

Accept		application/geo+json
Optional in header
string

Response

200

Single Device

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -79.347015,
              43.65107
            ],
            [
              -79.335023236092155,
              43.648744362183351
            ],
            [
              -79.334599731877091,
              43.651069328187674
            ],
            [
              -79.335022307606323,
              43.653394384197789
            ],
            [
              -79.336262258216252,
              43.655561072509869
            ],
            [
              -79.338235151067309,
              43.657421712335726
            ],
            [
              -79.340806561669183,
              43.658849470583732
            ],
            [
              -79.343801227802814,
              43.659747014319024
            ],
            [
              -79.347015,
              43.65107
            ]
          ]
        ]
      },
      "properties": {
        "timestamp": "2020-11-11T23:45:00Z",
        "imsi": "302690000000001",
        "radius": 1000
      }
    }
  ]
}

200

Multiple Devices

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -79.347015,
              43.65107
            ],
            [
              -79.335023236092155,
              43.648744362183351
            ],
            [
              -79.334599731877091,
              43.651069328187674
            ],
            [
              -79.335022307606323,
              43.653394384197789
            ],
            [
              -79.336262258216252,
              43.655561072509869
            ],
            [
              -79.338235151067309,
              43.657421712335726
            ],
            [
              -79.340806561669183,
              43.658849470583732
            ],
            [
              -79.343801227802814,
              43.659747014319024
            ],
            [
              -79.347015,
              43.65107
            ]
          ]
        ]
      },
      "properties": {
        "timestamp": "2020-11-11T23:45:00Z",
        "imsi": "302690000000001",
        "radius": 1000
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -79.35,
          43.66
        ]
      },
      "properties": {
        "timestamp": "2020-11-11T13:45:00Z",
        "imsi": "302690000000002"
      }
    }
  ]
}

204

None of the devices or locations is found

400

Bad Request

{
  "type": "https://api.iot.bell.ca/validation-error",
  "title": "The request is invalid",
  "instance": "/devices?imsi=301690000000000",
  "detail": "The 'imsi' is invalid: it should be a number 
  that starts with '302' and is followed by 12 digits"
}

401

The customer can't access this information for one of the following reasons: * the customer doesn't have access to this API: no `device-location` scope * none of the devices belongs to the customer

403

The customer can't be authenticated because the JWT token is invalid

500

Internal Server Error

Get Device Location History

Path

GET /devices/locations/history

Parameters

imsi		The IMSI(s) of the device(s). The IMSI ( International Mobile Subscriber Identity ) is defined by the [E.212 standard](https://www.itu.int/rec/T-REC-E.212/en).
Optional in Query		302690000000000
string

msisdn		The phone number(s) associated with the device(s). The MSISDN ( Mobile Station International Subscriber Directory Number ) is defined by the [E.164 standard](https://www.itu.int/rec/T-REC-E.164-201011-I/en).
Optional in Query		11234567890
string

correlationId		This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
Optional In Header
string

Accept		application/geo+json
Optional in header
string

Response

200

Single Device

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -79.347015,
              43.65107
            ],
            [
              -79.335023236092155,
              43.648744362183351
            ],
            [
              -79.334599731877091,
              43.651069328187674
            ],
            [
              -79.335022307606323,
              43.653394384197789
            ],
            [
              -79.336262258216252,
              43.655561072509869
            ],
            [
              -79.338235151067309,
              43.657421712335726
            ],
            [
              -79.340806561669183,
              43.658849470583732
            ],
            [
              -79.343801227802814,
              43.659747014319024
            ],
            [
              -79.347015,
              43.65107
            ]
          ]
        ]
      },
      "properties": {
        "timestamp": "2020-11-11T23:45:00Z",
        "imsi": "302690000000001",
        "radius": 1000
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -79.35,
          43.66
        ]
      },
      "properties": {
        "timestamp": "2020-11-11T13:45:00Z",
        "imsi": "302690000000001"
      }
    }
  ]
}

204

None of the devices or locations is found

400

Bad Request

{
  "type": "https://api.iot.bell.ca/validation-error",
  "title": "The request is invalid",
  "instance": "/devices?imsi=301690000000000",
  "detail": "The 'imsi' is invalid: it should be a number that starts with '302' and is followed by 12 digits"
}

401

The customer can't access this information for one of the following reasons: * the customer doesn't have access to this API: no `device-location` scope * none of the devices belongs to the customer

403

The customer can't be authenticated because the JWT token is invalid

500

Internal Server Error

Business overview

This API gives the details and low accuracy location of Non-GPS IoT devices that connect to the Bell wireless LTE/LTE-M network.

Get device details

Path

GET /devices

Parameters

imsi		The IMSI(s) of the device(s). The IMSI ( International Mobile Subscriber Identity ) is defined by the [E.212 standard](https://www.itu.int/rec/T-REC-E.212/en).
Optional in Query		302690000000000
string

msisdn		The phone number(s) associated with the device(s). The MSISDN ( Mobile Station International Subscriber Directory Number ) is defined by the [E.164 standard](https://www.itu.int/rec/T-REC-E.164-201011-I/en).
Optional in Query		11234567890
string

correlationId		This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
Optional In Header
string

Accept		application/json
Optional in header
string

Response

200

Device Details

{
  "msisdn": "11234567890",
  "imsi": "302690000000000",
  "iccid": "12345678901234567890",
  "status": "Active",
  "operator": "Bell",
  "dcp": "Ericsson",
  "label": "Test Device",
  "companyId": "00000001",
  "companyName": "Company-1"
}

204

None of the devices is found

400

Bad Request

{
  "type": "https://api.iot.bell.ca/validation-error",
  "title": "The request is invalid",
  "instance": "/devices?imsi=301690000000000",
  "detail": "The 'imsi' is invalid: it should be a number 
  that starts with '302' and is followed by 12 digits"
}

401

The customer can't access this information for one of the following reasons: * the customer doesn't have access to this API: no `device-details` scope * none of the devices belongs to the customer

403

The customer can't be authenticated because the JWT token is invalid

500

Internal Server Error

Get Latest Device Location

Path

GET /devices/locations

Parameters

imsi		The IMSI(s) of the device(s). The IMSI ( International Mobile Subscriber Identity ) is defined by the [E.212 standard](https://www.itu.int/rec/T-REC-E.212/en).
Optional in Query		302690000000000
string

msisdn		The phone number(s) associated with the device(s). The MSISDN ( Mobile Station International Subscriber Directory Number ) is defined by the [E.164 standard](https://www.itu.int/rec/T-REC-E.164-201011-I/en).
Optional in Query		11234567890
string

correlationId		This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
Optional In Header
string

Accept		application/geo+json
Optional in header
string

Response

200

Single Device

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -79.347015,
              43.65107
            ],
            [
              -79.335023236092155,
              43.648744362183351
            ],
            [
              -79.334599731877091,
              43.651069328187674
            ],
            [
              -79.335022307606323,
              43.653394384197789
            ],
            [
              -79.336262258216252,
              43.655561072509869
            ],
            [
              -79.338235151067309,
              43.657421712335726
            ],
            [
              -79.340806561669183,
              43.658849470583732
            ],
            [
              -79.343801227802814,
              43.659747014319024
            ],
            [
              -79.347015,
              43.65107
            ]
          ]
        ]
      },
      "properties": {
        "timestamp": "2020-11-11T23:45:00Z",
        "imsi": "302690000000001",
        "radius": 1000
      }
    }
  ]
}

200

Multiple Devices

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -79.347015,
              43.65107
            ],
            [
              -79.335023236092155,
              43.648744362183351
            ],
            [
              -79.334599731877091,
              43.651069328187674
            ],
            [
              -79.335022307606323,
              43.653394384197789
            ],
            [
              -79.336262258216252,
              43.655561072509869
            ],
            [
              -79.338235151067309,
              43.657421712335726
            ],
            [
              -79.340806561669183,
              43.658849470583732
            ],
            [
              -79.343801227802814,
              43.659747014319024
            ],
            [
              -79.347015,
              43.65107
            ]
          ]
        ]
      },
      "properties": {
        "timestamp": "2020-11-11T23:45:00Z",
        "imsi": "302690000000001",
        "radius": 1000
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -79.35,
          43.66
        ]
      },
      "properties": {
        "timestamp": "2020-11-11T13:45:00Z",
        "imsi": "302690000000002"
      }
    }
  ]
}

204

None of the devices or locations is found

400

Bad Request

{
  "type": "https://api.iot.bell.ca/validation-error",
  "title": "The request is invalid",
  "instance": "/devices?imsi=301690000000000",
  "detail": "The 'imsi' is invalid: it should be a number 
  that starts with '302' and is followed by 12 digits"
}

401

The customer can't access this information for one of the following reasons: * the customer doesn't have access to this API: no `device-location` scope * none of the devices belongs to the customer

403

The customer can't be authenticated because the JWT token is invalid

500

Internal Server Error

Get Device Location History

Path

GET /devices/locations/history

Parameters

imsi		The IMSI(s) of the device(s). The IMSI ( International Mobile Subscriber Identity ) is defined by the [E.212 standard](https://www.itu.int/rec/T-REC-E.212/en).
Optional in Query		302690000000000
string

msisdn		The phone number(s) associated with the device(s). The MSISDN ( Mobile Station International Subscriber Directory Number ) is defined by the [E.164 standard](https://www.itu.int/rec/T-REC-E.164-201011-I/en).
Optional in Query		11234567890
string

correlationId		This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
Optional In Header
string

Accept		application/geo+json
Optional in header
string

Response

200

Single Device

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -79.347015,
              43.65107
            ],
            [
              -79.335023236092155,
              43.648744362183351
            ],
            [
              -79.334599731877091,
              43.651069328187674
            ],
            [
              -79.335022307606323,
              43.653394384197789
            ],
            [
              -79.336262258216252,
              43.655561072509869
            ],
            [
              -79.338235151067309,
              43.657421712335726
            ],
            [
              -79.340806561669183,
              43.658849470583732
            ],
            [
              -79.343801227802814,
              43.659747014319024
            ],
            [
              -79.347015,
              43.65107
            ]
          ]
        ]
      },
      "properties": {
        "timestamp": "2020-11-11T23:45:00Z",
        "imsi": "302690000000001",
        "radius": 1000
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -79.35,
          43.66
        ]
      },
      "properties": {
        "timestamp": "2020-11-11T13:45:00Z",
        "imsi": "302690000000001"
      }
    }
  ]
}

204

None of the devices or locations is found

400

Bad Request

{
  "type": "https://api.iot.bell.ca/validation-error",
  "title": "The request is invalid",
  "instance": "/devices?imsi=301690000000000",
  "detail": "The 'imsi' is invalid: it should be a number that starts with '302' and is followed by 12 digits"
}

401

The customer can't access this information for one of the following reasons: * the customer doesn't have access to this API: no `device-location` scope * none of the devices belongs to the customer

403

The customer can't be authenticated because the JWT token is invalid

500

Internal Server Error

Ready to get started?