1GLOBAL Enterprise APIs (1.0)

Download OpenAPI specification:Download

1GLOBAL Enterprise APIs

Accounts

The Accounts API provides organizations with a complete view of their active business accounts(individual accounts representing specific organizational units, departments), offering information to enhance compliance monitoring and centralized management.

Use cases:

Compliance Oversight: Consolidates account details for streamlined compliance and regulatory monitoring.
Centralized Account Visibility: Enables administrators to access all organizational accounts, simplifying management with quick visibility into key details such as account name, status, and associated countries.

Prerequisites:

Obtain a relevant license for the API.

List Accounts

Get a list of all accounts associated with the organization.

Authorizations:

JWT

query Parameters

limit	integer <int32> (Limit) [ 1 .. 100 ] Default: 10 Specifies the maximum number of results to return in the response.
cursor	string (Cursor) [ 1 .. 128 ] characters Marker used for pagination to retrieve the next set of results in a list.

Responses

Response samples

200
401

Content type

application/json

{"_embedded": {"accounts": [{"id": "acc_045EAABBCCDD746VVV",
"name": "ABC, N.A. - LONDON BRANCH",
"country": "US",
"status": "active",
"_links": {"self": {"href": "https://api.1global.com/enterprise/accounts/acc_045EAABBCCDD746VVV"
}
}
}
]
}
}

Get Account

Returns information for a specific business account.

Authorizations:

JWT

path Parameters

id	string Example: acc_01HTJA47C93ABKKR58T05JBAJB Unique identifier for the business account.

Responses

Response samples

200
401
404

Content type

application/json

{"id": "acc_045EAABBCCDD746VVV",
"name": "ABC, N.A. - LONDON BRANCH",
"country": "US",
"status": "active",
"_links": {"self": {"href": "https://api.1global.com/enterprise/accounts/acc_045EAABBCCDD746VVV"
}
}
}

Subscribers

The Subscriber API allows organizations to retrieve a detailed list of their subscribers (individual users associated with the organization’s accounts e.g. employees).

Use cases:

Compliance and Security Oversight: Supports compliance requirements by giving visibility into individual subscriber data, allowing quick verification of subscriber name, group, and identification details.
Contact and Group Information Access: Allows administrators to view key subscriber details, including names, email addresses, employee IDs, and group affiliations, helping ensure data accuracy and alignment across the organization.

Pre-requisites:

Obtain a relevant license for the API.

List Subscribers

Authorizations:

JWT

query Parameters

limit	integer <int32> (Limit) [ 1 .. 100 ] Default: 10 Specifies the maximum number of results to return in the response.
cursor	string (Cursor) [ 1 .. 128 ] characters Marker used for pagination to retrieve the next set of results in a list.

Responses

Response samples

200
401

Content type

application/json

{"_embedded": {"subscribers": [{"id": "sbr_0123AAABBBBCCC123XY456",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"employee_id": "ED123",
"group": "E1",
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscribers/sbr_01HTQ8Z5HR26EN2HE797W5SZP9"
}
}
}
]
}
}

Get Subscriber

Authorizations:

JWT

path Parameters

id	string Example: sbr_01HTQ8Z5HR26EN2HE797W5SZP9 A unique identifier for the subscriber, formatted as a 26-character alphanumeric string prefixed with "sbr_"

Responses

Response samples

200
401
404

Content type

application/json

{"id": "sbr_0123AAABBBBCCC123XY456",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"employee_id": "ED123",
"group": "E1",
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscribers/sbr_01HTQ8Z5HR26EN2HE797W5SZP9"
}
}
}

Subscriptions

Endpoints for managing your subscriptions

List Subscriptions

Authorizations:

JWT

query Parameters

status	string Enum: "active" "terminated" The status of the subscription
limit	integer <int32> (Limit) [ 1 .. 100 ] Default: 10 Specifies the maximum number of results to return in the response.
cursor	string (Cursor) [ 1 .. 128 ] characters Marker used for pagination to retrieve the next set of results in a list.

header Parameters

Prefer

string

Example: transclude="subscriber;account;sim_profile;phone_numbers;services"

What embedded resources to include in the response

Responses

Response samples

200
401

Content type

application/json

{"_embedded": {"subscriptions": [{"id": "sub_01HTQ8ZW1JVSFRWJX51K4CTX7Y",
"status": "active",
"created_at": "2023-01-01T00:00:00:000Z",
"terminated_at": null,
"_embedded": {"account": {"id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
"reference_code": "123456789",
"name": "ABC, N.A. - LONDON BRANCH",
"country": "US"
},
"subscriber": {"id": "sbr_01HTQ8Z5HR26EN2HE797W5SZP9",
"first_name": "string",
"last_name": "string",
"email": "string",
"employee_id": "string",
"group": "string"
},
"sim_profile": {"iccid": "string",
"sim_type": "esim",
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/sim-profile"
}
}
},
"phone_numbers": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/phone-numbers"
}
},
"_embedded": {"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
]
}
},
"services": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/services"
}
},
"_embedded": {"services": [{"type": "voice",
"enabled": true
}
]
}
}
}
}
]
}
}

Get Subscription

Authorizations:

JWT

path Parameters

id	string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription

header Parameters

Prefer

string

Example: transclude="subscriber;account;sim_profile;phone_numbers;services"

What embedded resources to include in the response

Responses

Response samples

200
401
404

Content type

application/json

{"id": "sub_01HTQ8ZW1JVSFRWJX51K4CTX7Y",
"status": "active",
"created_at": "2023-01-01T00:00:00:000Z",
"terminated_at": null,
"_embedded": {"account": {"id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
"reference_code": "123456789",
"name": "ABC, N.A. - LONDON BRANCH",
"country": "US"
},
"subscriber": {"id": "sbr_01HTQ8Z5HR26EN2HE797W5SZP9",
"first_name": "string",
"last_name": "string",
"email": "string",
"employee_id": "string",
"group": "string"
},
"sim_profile": {"iccid": "string",
"sim_type": "esim",
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/sim-profile"
}
}
},
"phone_numbers": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/phone-numbers"
}
},
"_embedded": {"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
]
}
},
"services": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/services"
}
},
"_embedded": {"services": [{"type": "voice",
"enabled": true
}
]
}
}
}
}

Get Subscription's Phone Numbers

Authorizations:

JWT

path Parameters

id	string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription

Responses

Response samples

200
401
404

Content type

application/hal+json

{"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/phone-numbers"
}
},
"_embedded": {"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
]
}
}

Messages

The Messages API allows organizations to send SMS messages directly from authorized subscription numbers to one or more recipients.

Use cases:

Alert messages: for critical situations requiring immediate action such as emergency alerts or safety notifications.
Updates and Notifications: keep customers informed with reminders, updates, and notifications.
Marketing messages: send targeted promotional SMS messages to drive engagement,sales and customer interest.
Customer service: enable proactive engagement improving customer experience.

Notes:

This API incurs separate billing, and the charges for messages sent are consumed by the SMS plan associated with the authorized subscription number.
This is a Premium API, and is licensed separately.

Prerequisites:

Obtain a relevant license for the API.
Provide 1GLOBAL with a list of allowed subscription numbers authorized to send SMS messages through the API.

Send SMS

Sends SMS messages from authorized subscription numbers to specified recipients.

Authorizations:

JWT

Request Body schema: application/json

from	string^(\+\d{1,15}\|\d{1,15})$ Authorized subscription number sending the message, in E.164 format
to	Array of strings (Msisdn) <= 1000 items [^(\+\d{1,15}\|\d{1,15})$] Array of up to 1,000 recipient phone numbers in E.164 format
text	string <= 500 characters The content of the SMS message, limited to 500 characters.

Responses

Request samples

Payload

Content type

application/json

{"from": "+11114567890",
"to": ["+1234567890"
],
"text": "Thank you for using our service"
}

Response samples

200
400
401

Content type

application/json

{"sms_id": "sms_01JBCG33BC2PS4J76JN685GN56"
}