Skip to main content
Blocklists restrict which networks a SIM can attach to. Assign a blocklist to a SIM Card Group and every SIM in that group is blocked from the listed networks. A SIM Card Group can have one blocklist assigned.

Choose the Blocking Granularity

The blocklist type determines how each value is resolved into blocked networks. All values in a blocklist must use the same type.

How Blocklists Combine

Three blocklist scopes can apply to an IMSI: A SIM typically contains five IMSIs, each able to roam on a specific roaming platform. Global and roaming-platform blocklists are visible to users, but cannot be modified. They are not currently exposed through the API. The effective blocklist for an IMSI is the union of all three scopes:
A network is blocked if it appears in any applicable blocklist. Removing a value from a SIM Card Group blocklist does not allow that network if it remains on the global or roaming-platform blocklist.

Workflow

1. List Valid Values

Call GET /wireless_blocklist_values with the required type query parameter:
The response field depends on the requested type: Use values returned for the selected type. Do not mix value types in one blocklist.

2. Create the Blocklist

Send POST /wireless_blocklists with a name, the selected type, and its values:
The API returns 201 Created with the new blocklist:
The id in the response is the blocklist ID. Use it as the wireless_blocklist_id when assigning the blocklist to a SIM Card Group.

3. Assign the Blocklist

Send POST /sim_card_groups/{id}/actions/set_wireless_blocklist, using the SIM Card Group ID in the path:
The API returns 202 Accepted with a SIM Card Group action:
The id in this response is the action ID. A status of in-progress means the blocklist assignment has not completed.

4. Confirm the Assignment

Poll GET /sim_card_group_actions/{id} with the action ID until the status is completed.
  • in-progress: continue polling.
  • completed: the blocklist is assigned to the group.
After the action completes, all SIMs in the group inherit the blocklist.