TM Forum Open API

Communication Management API

Send messages to customers on the Ooredoo network

The Communication Management API is designed to facilitate structured and automated communication between businesses, users, and stakeholders.

  • Notifications
  • Alerts
  • Reminders

What you can do with this API

Ready to test? Jump to the sample call and the API reference, where you can try every endpoint. Start testing
Read the full API overview

The Communication Management API is designed to facilitate structured and automated communication between businesses, users, and stakeholders. It provides a standardized way to create, send, and manage communications in various formats, ensuring timely and efficient interactions.

Key Features & Functionality:

  1. Multi-Channel Communication:
    • Supports sending messages via email, SMS, push notifications, in-app alerts, or system-generated instructions.
    • Ensures messages reach recipients through their preferred channel.
  2. Personalization & Targeting:
    • Allows customization of messages based on user preferences, roles, or organizational needs.
    • Supports dynamic content generation for personalized notifications.
  3. Event-Driven Messaging:
    • Can trigger communications based on specific events (e.g., a user action, a scheduled update, or system alerts).
    • Ensures real-time or scheduled notifications based on predefined rules.
  4. Message Tracking & Analytics:
    • Provides tracking capabilities to monitor delivery, read receipts, and user engagement metrics.
    • Helps businesses optimize messaging strategies and improve response rates.
  5. Security & Compliance:
    • Ensures data encryption and authentication to protect sensitive communications.
    • Complies with industry regulations like GDPR, HIPAA, and other data protection standards.
  6. Integration with CRM & ERP Systems:
    • Works seamlessly with CRM systems to send targeted customer communications.
    • Can integrate with business workflow platforms for automated notifications and instructions.

Use Cases:

  • Customer Notifications: Sending billing updates, promotional offers, or transaction confirmations.
  • Internal Alerts: Notifying employees of system changes, approvals, or organizational updates.
  • Appointment Reminders: Automating reminders for bookings, payments, or deliveries.
  • Emergency Communications: Providing timely alerts for security or technical incidents.

Questions about the Communication Management API

What can I do with the Communication Management API?

The Communication Management API is designed to facilitate structured and automated communication between businesses, users, and stakeholders.

  • Send a message to a customer (POST /communicationMessage)
Which inputs does each call to the Communication Management API need?
  • POST /communicationMessage: requires content, messageType, receiver, sender; headers countryCode, transactionId

Every call also needs Authorization: Bearer <access_token>. The API reference on this page shows each field's type and an example request.

What does the Communication Management API return?
  • POST /communicationMessage returns HTTP 201 with name, content, description, messageType, priority, subject

Responses are JSON.

How do I authenticate with the Communication Management API?
  1. Call POST https://api.ooredoo.com/tmf-api/oauth/v4/token with client_id, client_secret in the headers. Send grant_type in the body. Use the client ID and secret of your app.
  2. The response contains access_token, token_type, expires_in, consented_on, created_At, expired_At.
  3. Send Authorization: Bearer <access_token> on each call until the token expires, then request a new one.
Which errors can the Communication Management API return?
  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 405: Method Not allowed
  • 409: Conflict
  • 500: Internal Server Error

On 401, request a new access token and retry.

Where is the Communication Management API available?

Communication Management is available in Algeria, Iraq, Kuwait, Maldives, Oman, Qatar, Tunisia and Palestine.

Which standard does the Communication Management API follow?

It follows the TM Forum Open API standard used across the telecom industry. See our TM Forum certification page.

Related APIs

Sample call

From the published OpenAPI specification. Replace the placeholders with your app's credentials and real values.

1. Get an access token

curl -X POST https://api.ooredoo.com/tmf-api/oauth/v4/token \
  -H "client_id: $CLIENT_ID" \
  -H "client_secret: $CLIENT_SECRET" \
  -d "grant_type=client_credentials"

2. Call the API

curl -X POST https://api.ooredoo.com/tmf-api/communicationManagement/v4/communicationMessage \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "countryCode: <countryCode>" \
  -H "transactionId: <transactionId>" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Dear Karti, Here is the information of the promotion",
    "messageType": "sms",
    "receiver": [
      {
        "phoneNumber": "+974XXXXXXXX"
      }
    ],
    "sender": {
      "name": "Karti"
    }
  }'

API reference

Try any endpoint in the sandbox