Vela Mobile API Documentation

MW API DOC

Manage optional features and services, such as Wi-Fi Calling, voicemail, and device location.


Wi-Fi Calling

Add WFC Feature

Enable Wi-Fi Calling and set E911 address.

Endpoint: POST /sim/wfc/add/

Rate Limit: 20 requests/minute

Authentication: Bearer token required

Request Body

Field Type Required Description
mdn string Yes 10-digit Mobile Number
sim string Yes ICCID (alphanumeric, max 25 characters)
address1 string Yes Street Address
city string Yes City
state string Yes 2-letter US State Code
zip_code string Yes 5-digit ZIP Code
address2 string No Street Address Line 2
transaction_id string No Unique Transaction ID (auto-generated with ADD_WFC_ prefix if not provided)

Request Example

{
  "mdn": "5550199888",
  "sim": "89014103211118500000",
  "address1": "222 XYZ St",
  "city": "Seattle",
  "state": "WA",
  "zip_code": "98104",
  "transaction_id": "ADD_WFC_TX123"
}

Response Examples

Success (200 OK):

{
  "status": "success",
  "mdn": "5550199888",
  "sim": "89014103211118500000",
  "transaction_id": "ADD_WFC_1C68F4E4797B",
  "message": "Success"
}

Common Errors (400 Bad Request):

{
  "status": "failure",
  "mdn": "5550199888",
  "sim": "89014103211118500000",
  "transaction_id": "ADD_WFC_6CFD3955E9FE",
  "message": "DUPLICATE PRODUCTS (GENS-0010)"
}
{
  "status": "failure",
  "mdn": "5550199888",
  "sim": "89014103211118500000",
  "transaction_id": "ADD_WFC_1ABD6DD085F8",
  "message": "INVALID E911 ADDRESS (GENS-0090)"
}
{
  "status": "failure",
  "mdn": "5550199888",
  "sim": "89014103211118500000",
  "transaction_id": "ADD_WFC_CCCA08B3AECE",
  "message": "SUBSCRIBER WITH GIVEN RESOURCE NOT EXISTS. (918)"
}
{
  "status": "failure",
  "mdn": "5550199888",
  "sim": "89014103211118500000",
  "transaction_id": "ADD_WFC_B15C731E74B2",
  "message": "ESN/MDN is Inactive (915)"
}

Idempotency Error (409 Conflict):

{
  "status": "failure",
  "message": "Transaction ID already exists",
  "code": "HTTP_409"
}

Possible Error Codes

GENS-0010, GENS-0090, GENS-0109, GENS-0170, GENS-0173, (918), (915), (909)

For full error details see Error & Response Codes.


Update WFC Address

Update the E911 address for an existing WFC subscriber.

Endpoint: POST /sim/wfc/address/

Rate Limit: 20 requests/minute

Authentication: Bearer token required

Request Body

Field Type Required Description
mdn string Yes 10-digit Mobile Number
address1 string Yes Street Address
city string Yes City
state string Yes 2-letter US State Code
zip_code string Yes 5-digit ZIP Code
sim string No ICCID (optional verification)
address2 string No Street Address Line 2
transaction_id string No Unique Transaction ID (auto-generated with UPD_WFC_ADDR_ prefix if not provided)

Request Example

{
  "mdn": "5550199888",
  "sim": "89014103211118500000",
  "address1": "888 New Address St",
  "city": "New York",
  "state": "NY",
  "zip_code": "10001",
  "transaction_id": "UPD_WFC_ADDR_TX123"
}

Response Examples

Success (200 OK):

{
  "status": "success",
  "mdn": "5550199888",
  "sim": "89014103211118500000",
  "transaction_id": "UPD_WFC_ADDR_1C68F4E4797B",
  "message": "Success"
}

Common Errors (400 Bad Request):

{
  "status": "failure",
  "mdn": "5550199888",
  "transaction_id": "UPD_WFC_ADDR_6CFD3955E9FE",
  "message": "INVALID E911 ADDRESS (GENS-0090)"
}
{
  "status": "failure",
  "mdn": "5550199888",
  "transaction_id": "UPD_WFC_ADDR_B15C731E74B2",
  "message": "Cannot Update E911, WFC not active (GENS-0124)"
}

Idempotency Error (409 Conflict):

{
  "status": "failure",
  "message": "Transaction ID already exists",
  "code": "HTTP_409"
}

Possible Error Codes

GENS-0090, GENS-0124, GENS-0404, (918), (915), (909)

For full error details see Error & Response Codes.


Voicemail Management

Reset Voicemail Password

Reset a subscriber's voicemail password to the default.

Endpoint: POST /sim/voicemail/reset/

Rate Limit: 20 requests/minute

Authentication: Bearer token required

Request Body

Field Type Required Description
mdn string Yes 10-digit Mobile Number
sim string No SIM identifier (ICCID) — alphanumeric, max 25 characters
transaction_id string No Unique Transaction ID (auto-generated with VM_RESET_ prefix if not provided)

Request Example

{
  "mdn": "5550199888",
  "sim": "89014103211118500000",
  "transaction_id": "VM_RESET_TX123"
}

Response Examples

Success (200 OK):

{
  "status": "success",
  "mdn": "5550199888",
  "transaction_id": "VM_RESET_1C68F4E4797B",
  "message": "Success"
}

Common Errors (400 Bad Request):

{
  "status": "failure",
  "mdn": "5550199888",
  "transaction_id": "VM_RESET_00627C3E7BC3",
  "message": "SUBSCRIBER WITH GIVEN RESOURCE NOT EXISTS. (918)"
}
{
  "status": "failure",
  "mdn": "5550199888",
  "transaction_id": "VM_RESET_B15C731E74B2",
  "message": "ESN/MDN is Inactive (915)"
}

Idempotency Error (409 Conflict):

{
  "status": "failure",
  "message": "Transaction ID already exists",
  "code": "HTTP_409"
}

Possible Error Codes

(918), (915), (909), GENS-0149

For full error details see Error & Response Codes.


Change Voicemail Language

Change a subscriber's voicemail greeting and menu language.

Endpoint: POST /sim/voicemail/language/

Rate Limit: 20 requests/minute

Authentication: Bearer token required

Request Body

Field Type Required Description
mdn string Yes 10-digit Mobile Number
language string Yes Language code — ENGL (English) or SPAN (Spanish) only
transaction_id string No Unique Transaction ID (auto-generated with VM_LANG_ prefix if not provided)

Request Example

{
  "mdn": "5550199888",
  "language": "SPAN",
  "transaction_id": "VM_LANG_TX123"
}

Response Examples

Success (200 OK):

{
  "status": "success",
  "mdn": "5550199888",
  "transaction_id": "VM_LANG_1C68F4E4797B",
  "message": "Success"
}

Common Errors (400 Bad Request):

{
  "status": "failure",
  "mdn": "5550199888",
  "transaction_id": "VM_LANG_00627C3E7BC3",
  "message": "SUBSCRIBER WITH GIVEN RESOURCE NOT EXISTS. (918)"
}
{
  "status": "failure",
  "mdn": "5550199888",
  "transaction_id": "VM_LANG_B15C731E74B2",
  "message": "ESN/MDN is Inactive (915)"
}

Validation Error (422 Unprocessable Entity):

{
  "detail": [
    {
      "type": "value_error",
      "loc": ["body", "language"],
      "msg": "Value error, Language must be one of: ENGL, SPAN"
    }
  ]
}

Idempotency Error (409 Conflict):

{
  "status": "failure",
  "message": "Transaction ID already exists",
  "code": "HTTP_409"
}

Possible Error Codes

(918), (915), (909), GENS-0177

For full error details see Error & Response Codes.


Device Location

Cancel Device Location Tracking

Cancel device location tracking for a subscriber line.

Endpoint: POST /sim/device-location/cancel/

Rate Limit: 20 requests/minute

Authentication: Bearer token required

Request Body

Field Type Required Description
mdn string Yes 10-digit Mobile Number
transaction_id string No Unique Transaction ID (auto-generated with CANCEL_LOC_ prefix if not provided)

Request Example

{
  "mdn": "5550199888",
  "transaction_id": "CANCEL_LOC_TX123"
}

Response Examples

Success (200 OK):

{
  "status": "success",
  "mdn": "5550199888",
  "transaction_id": "CANCEL_LOC_1C68F4E4797B",
  "message": "Success"
}

Common Errors (400 Bad Request):

{
  "status": "failure",
  "mdn": "5550199888",
  "transaction_id": "CANCEL_LOC_00627C3E7BC3",
  "message": "SUBSCRIBER WITH GIVEN RESOURCE NOT EXISTS. (918)"
}
{
  "status": "failure",
  "mdn": "5550199888",
  "transaction_id": "CANCEL_LOC_B15C731E74B2",
  "message": "ESN/MDN is Inactive (915)"
}

Idempotency Error (409 Conflict):

{
  "status": "failure",
  "message": "Transaction ID already exists",
  "code": "HTTP_409"
}

Possible Error Codes

(918), (915), (909)

For full error details see Error & Response Codes.


Common HTTP Errors (All Endpoints on This Page)

HTTP Code Meaning
400 Bad request / upstream carrier operation failed
401 Not authenticated (missing or invalid Bearer token)
403 Forbidden (insufficient permissions)
409 Conflict (duplicate transaction_id)
422 Validation error (invalid state code, ZIP format, MDN format)
429 Rate limit exceeded
500 Internal server error

Full error reference: Error & Response Codes