Skip to content

Create an Access or API Account$

Authorized Users

  • Super Admin
  • Admin

Step 1: Configure Basic Details$

  1. Login to the Wisely platform using a valid username and password.
  2. Navigate to the API icon from the left menu.
  3. Click Create New at the top right corner of the page. The Create Access Account form opens.
  4. In the Create Access Account form - Choose Communication Type:
    • Outgoing Messages: Allows one-way communication
    • Conversational: Allows bi-directional communication
  5. In the Account Label field, enter a name.
  6. In the Business Group field, select an appropriate business group from the drop-down. If no option is available, then you will need to create a business group. Refer to creating a business group.
  7. In the Type of traffic field, choose an option from the drop-down menu. These options apply to Outgoing messages only.
    1. OTP
    2. Transactional
    3. Promotional
  8. In the Select Channel field, choose one or more channel(s) from the drop-down menu.
    1. RCS
    2. SMS
    3. TrueCaller
    4. WhatsApp

outgoing conversational

Step 2: Configure Advanced Settings$

API & Security Settings$

Set up the following parameters.

  1. IP Restrictions: Choose any of the following:
    • Allow access from any IP: Every IP can access this account.
    • Restrict to the list: Add IPs that you want to restrict access to.
  2. Data Protection for Message Content and Mobile Number: Choose any of the following:
    • Store securely: Stores your message content and mobile number on the server.
    • Do not Store: Do not store your message content and mobile number.
    • Encrypt & Store: Encrypts and stores your message content and mobile number securely.
  3. Encrypt Payload: Ensures the confidentiality and integrity of data transmitted over servers to the client. Wisely supports Advanced Encryption Standard (AES) in which both sender and receiver use the same secret key to encrypt and decrypt the payload. Choose the encryption method (AES 128 and AES256) and enter the passphrase and version code to encrypt the payload.

ip1

ip2

Channel Resources$

Set up the following channel settings:

  1. Consent Management: By default, "No consent needed" is applied.

    • Lookup explicit Opt-in: Check this box to search for users who have opted in to receive messages.
    • Lookup explicit Opt-out: Check this box to search for users who have opted out of receiving messages.

  2. RCS Settings: These settings apply only when the RCS channel is selected. Choose the appropriate options under these settings.

    1. Agent Providers: Select one or more telcos (e.g., Vodafone Idea, Reliance Jio) from the drop-down list.
    2. Access to RCS Agents:
      • Allow access to all agents: Enables all agent IDs to access the account.
      • Restrict to List: Add a list of agent IDs you want to restrict access to this account.
    3. Verify Channel Profile:
      • Strict: Sends messages if the end-user has the RCS channel.
      • Non-strict: Sends messages regardless of the end user’s receiving channels.
    4. Fallback: Switch on the toggle button to enable a fallback channel.
      • Fallback Channel: Choose an alternate channel to route the message if the user does not receive the message sent via the RCS channel.
      • Events: Select the types of events for which you would like to route the message to an alternate channel:
        • Delivery Failed
        • DR TTL Expired: Enter the number of seconds to implement a fallback to the alternate channel (e.g., 20 seconds).
        • Invalid Number
        • Message Validity Expired

    rcssettings

  3. WhatsApp Settings: These are applicable only when the WhatsApp channel is selected.

    1. Access to WABA Agents:
      • Allow access to all WABA: Enables all WABA numbers to access the account.
      • Restrict to List: Adds a list of WABA numbers that you want to restrict access to in this account.
    2. Verify Channel Profile: Enable the toggle button to verify the channel profile. Choose any of the following verification types:
      • Strict: Sends messages if the end-user has the WhatsApp channel enabled on their device.
      • Non-strict: Sends messages regardless of the end user’s receiving channels.
    3. Traffic Management: Enable the toggle button to balance the message payload. Choose an appropriate load balancing type from the options below:
      • Round Robin: A load-balancing technique that cyclically forwards client requests through a group of servers.
      • Capacity-Based Distribution: This technique adjusts traffic distribution in real-time based on current capacity and utilization.
    4. Fallback: Switch on the toggle button to enable a fallback channel.
      • Fallback Channel: Choose an alternate channel to route the message if the user does not receive the message sent via WhatsApp channel.
      • Events: Select the types of events for which you would like to route the message to an alternate channel. These events include:
        • Delivery Failed
        • DR TTL Expired: Enter the number of seconds to implement a fallback to the alternate channel. For example, if you enter 20 seconds, the system implements the fallback mechanism to alternate channels you have configured.
        • Invalid Number
        • Message Validity Expired

    whatsappsettings

  4. Truecaller Settings: These are applicable only when the Truecaller channel is selected.

    1. Access to TrueCaller Numbers: Choose any of the following.
      • Allow access to all TrueCaller Numbers: Enables all numbers to access the account.
      • Restrict to List: Add a list of numbers you want to restrict access to this account.
    2. Verify Channel Profile: Enable the toggle button to verify the channel profile. Choose any of the following verification types:
      • Strict: Sends messages if the end-user has the TrueCaller channel enabled on their device.
      • Non-strict: Sends messages regardless of the end user’s receiving channels.
    3. Traffic Management: Enable the toggle button to balance the message payload. Choose an appropriate load balancing type from the options below:
      • Round Robin: A load-balancing technique that cyclically forwards client requests through a group of servers.
    4. Fallback: Switch on the toggle button to enable an alternate channel to send a message.
      • Fallback Channel: Choose an alternate channel to route the message if the user does not receive the message sent via the Truecaller channel.
      • Events: Select the types of events for which you would like to route the message to an alternate channel. These events include:
        • Delivery Failed
        • DR TTL Expired: Enter the number of seconds to implement a fallback to the alternate channel. For example, if you enter 20 seconds, the system implements the fallback mechanism to alternate channels you have configured.
        • Invalid Number
        • Message Validity Expired

    tcsettings

  5. SMS Settings: These are applicable only when the SMS channel is selected.

    1. Access to Sender ID: Choose any of the following.
      • Allow access to all Sender IDs: Enables all sender IDs to access the account.
      • Restrict to List: Add a list of sender IDs that you want to restrict access to this account.
    2. Fallback: Switch on the toggle button to enable a fallback channel.
      • Fallback Channel: Choose an alternate channel to route the message if the user does not receive the message sent via the SMS channel.
      • Events: Select the types of events for which you would like to route the message to an alternate channel. These events include:
        • Delivery Failed
        • DR TTL Expired: Enter the number of seconds to implement a fallback to the alternate channel. For example, if you enter 20 seconds, the system implements the fallback mechanism to alternate channels you have configured.
        • Invalid Number
        • Message Validity Expired

    smssettings

Webhook for Outgoing Status Events$

Set up the webhook to receive notifications of the message delivery status.

  1. Events: Select the following events to receive notifications on the endpoint:
    • Delivery Status: Notification if the message is delivered or failed.
    • Sent: Notification when the message is sent to the end user from the platform.
    • Read: Notification when the end user reads your message.
    • Typing: Notification when the end user starts replying (Conversational type only).
  2. Payload Format: Select your desired format:
    • Native: Callback notifications to Campaign Manager
    • CleverTap: Callback notifications to CleverTap
    • MoEngage: Callback notifications to MoEngage
    • WebEngage: Callback notifications to WebEngage
  3. Intermediate Delivery Notification: (Optional) Enable to receive an intermediate callback notification in case of a fallback from one channel to another (Delivery Status events only).
  4. Protocol: Select the protocol for notifications:
    • NATS: High-performance messaging system. Example: nats://webhook.site/81xxxxxxxx-xxxxxx-xxxxx_test
    • HTTPS: Secures communication. Example: https://webhook.site/81xxxxxxxx-xxxxxx-xxxxx_test
  5. Metadata Header: (Optional) Enable to include metadata key:value pairs in the payload.
  6. Retries & Batch Notifications:
    • Retries: Retries failed webhook notifications (max 3).
    • Batch Notifications: Receive status of multiple events in a single notification (max 50 events per batch).

  7. Encrypt Payload: Ensures the confidentiality and integrity of data transmitted to the webhook receiver. Wisely supports Advanced Encryption Standard (AES) in which both sender and receiver use the same secret key to encrypt and decrypt the payload. Choose AES 128 or AES256 and enter the passphrase and version code to encrypt the payload.

    webhook1

    webhook2

    webhook3

    webhook4

Webhook for User-Initiated Messages$

Set up the webhook to receive notifications when the user responds to your message.

Note

This setting applies to the Conversation communication type only.

  1. Webhook URL: Select the desired protocol for receiving notifications:
    • NATS: High-performance messaging system. Example: nats://webhook.site/81xxxxxxxx-xxxxxx-xxxxx_test
    • HTTPS: Secures communication. Example: https://webhook.site/81xxxxxxxx-xxxxxx-xxxxx_test
  2. Payload Format: Select your desired format:
    • Native: User-initiated notifications to Campaign Manager
    • CleverTap: User-initiated notifications to CleverTap
    • MoEngage: User-initiated notifications to MoEngage
    • WebEngage: User-initiated notifications to WebEngage
  3. Retries: Retries enable the platform to resend any webhook notifications that failed to hand over to the webhook URL. A maximum of 3 retries are allowed.
  4. Metadata Header: (Optional) Enable to include metadata key:value pairs with the payload while sending an event to the platform.

  5. Encryption: Ensures the confidentiality and integrity of data transmitted to the webhook receiver. Wisely supports Advanced Encryption Standard (AES) in which both sender and receiver use the same secret key to encrypt and decrypt the payload. Choose AES 128 or AES256 and enter the passphrase and version code to encrypt the payload.

    user-initiated

    user-initiated

Manage App settings$

Enable/disable Apps that you have subscribed to in the App module. Currently, Wisley supports the following Apps:

  • Template Lookup: Searches for approved templates to be included in your message.
  • URL Shortener: Shortens the long and unreadable URLs that are included in your message.
  • Campaign Manager: Campaign Manager, a web-based application, empowers businesses to plan, execute, and track all enterprise campaigns.

  • Digital Asset Manager: The Digital Asset Library (DAM) App allows users to upload, organize, and manage media assets—including images, videos, and audio—for use across various messaging channels like WhatsApp, RCS, and Truecaller

    manageapp

Step 3: Click Create.$

Your access account and API key will be generated.

Step 1: Configure Basic Details$

  1. Login to the Aggregator platform using a valid username and password.
  2. Navigate to the API icon from the left menu.
  3. Click Create New at the top right corner of the page. The Create Access Account form opens.
  4. In the Create Access Account form - Choose Communication Type:
    • Outgoing Messages: Allows one-way communication
    • Conversational: Allows bi-directional communication
  5. Select the Enterprise Name from the dropdown menu.
  6. In the Account Label field, enter a name.
  7. In the Business Group field, select an appropriate business group from the drop-down. If no option is available, then you will need to create a business group. Refer to creating a business group.
  8. In the Type of traffic field, choose an option from the drop-down menu. These options apply to Outgoing messages only.
    1. OTP
    2. Transactional
    3. Promotional
  9. In the Select Channel field, choose one or more channel(s) from the drop-down menu.
    1. RCS
    2. SMS
    3. TrueCaller
    4. WhatsApp

outgoing conversational

Step 2: Configure Advanced Settings$

API & Security Settings$

Set up the following parameters.

  1. IP Restrictions: Choose any of the following:
    • Allow access from any IP: Every IP can access this account.
    • Restrict to the list: Add IPs that you want to restrict access to.
  2. Data Protection for Message Content and Mobile Number: Choose any of the following:
    • Store securely: Stores your message content and mobile number on the server.
    • Do not Store: Do not store your message content and mobile number.
    • Encrypt & Store: Encrypts and stores your message content and mobile number securely.
  3. Encrypt Payload: Ensures the confidentiality and integrity of data transmitted over servers to the client. Wisely supports Advanced Encryption Standard (AES) in which both sender and receiver use the same secret key to encrypt and decrypt the payload. Choose the encryption method (AES 128 and AES256) and enter the passphrase and version code to encrypt the payload.

ip1

ip2

Channel Resources$

Set up the following channel settings:

  1. Consent Management: By default, "No consent needed" is applied.

    1. Lookup explicit Opt-in: Check this box to search for users who have opted in to receive messages.
    2. Lookup explicit Opt-out: Check this box to search for users who have opted out of receiving messages.

  2. RCS Settings: These settings apply only when the RCS channel is selected. Choose the appropriate options under these settings.

    1. Agent Providers: Select one or more telcos (e.g., Vodafone Idea, Reliance Jio) from the drop-down list.
    2. Access to RCS Agents:
      • Allow access to all agents: Enables all agent IDs to access the account.
      • Restrict to List: Add a list of agent IDs you want to restrict access to this account.
    3. Verify Channel Profile:
      • Strict: Sends messages if the end-user has the RCS channel.
      • Non-strict: Sends messages regardless of the end user’s receiving channels.
    4. Fallback: Switch on the toggle button to enable a fallback channel.
      • Fallback Channel: Choose an alternate channel to route the message if the user does not receive the message sent via the RCS channel.
      • Events: Select the types of events for which you would like to route the message to an alternate channel:
        • Delivery Failed
        • DR TTL Expired: Enter the number of seconds to implement a fallback to the alternate channel (e.g., 20 seconds).
        • Invalid Number
        • Message Validity Expired

    rcssettings

  3. WhatsApp Settings: These are applicable only when the WhatsApp channel is selected.

    1. Access to WABA Agents:
      • Allow access to all WABA: Enables all WABA numbers to access the account.
      • Restrict to List: Adds a list of WABA numbers that you want to restrict access to in this account.
    2. Verify Channel Profile: Enable the toggle button to verify the channel profile. Choose any of the following verification types:
      • Strict: Sends messages if the end-user has the WhatsApp channel enabled on their device.
      • Non-strict: Sends messages regardless of the end user’s receiving channels.
    3. Traffic Management: Enable the toggle button to balance the message payload. Choose an appropriate load balancing type from the options below:
      • Round Robin: A load-balancing technique that cyclically forwards client requests through a group of servers.
      • Capacity-Based Distribution: This technique adjusts traffic distribution in real-time based on current capacity and utilization.
    4. Fallback: Switch on the toggle button to enable a fallback channel.
      • Fallback Channel: Choose an alternate channel to route the message if the user does not receive the message sent via WhatsApp channel.
      • Events: Select the types of events for which you would like to route the message to an alternate channel. These events include:
        • Delivery Failed
        • DR TTL Expired: Enter the number of seconds to implement a fallback to the alternate channel. For example, if you enter 20 seconds, the system implements the fallback mechanism to alternate channels you have configured.
        • Invalid Number
        • Message Validity Expired

    whatsappsettings

  4. Truecaller Settings: These are applicable only when the Truecaller channel is selected.

    1. Access to TrueCaller Numbers: Choose any of the following.
      • Allow access to all TrueCaller Numbers: Enables all numbers to access the account.
      • Restrict to List: Add a list of numbers you want to restrict access to this account.
    2. Verify Channel Profile: Enable the toggle button to verify the channel profile. Choose any of the following verification types:
      • Strict: Sends messages if the end-user has the TrueCaller channel enabled on their device.
      • Non-strict: Sends messages regardless of the end user’s receiving channels.
    3. Traffic Management: Enable the toggle button to balance the message payload. Choose an appropriate load balancing type from the options below:
      • Round Robin: A load-balancing technique that cyclically forwards client requests through a group of servers.
    4. Fallback: Switch on the toggle button to enable an alternate channel to send a message.
      • Fallback Channel: Choose an alternate channel to route the message if the user does not receive the message sent via the Truecaller channel.
      • Events: Select the types of events for which you would like to route the message to an alternate channel. These events include:
        • Delivery Failed
        • DR TTL Expired: Enter the number of seconds to implement a fallback to the alternate channel. For example, if you enter 20 seconds, the system implements the fallback mechanism to alternate channels you have configured.
        • Invalid Number
        • Message Validity Expired

    tcsettings

  5. SMS Settings: These are applicable only when the SMS channel is selected.

    1. Access to Sender ID: Choose any of the following.
      • Allow access to all Sender IDs: Enables all sender IDs to access the account.
      • Restrict to List: Add a list of sender IDs that you want to restrict access to this account.
    2. Fallback: Switch on the toggle button to enable a fallback channel.
      • Fallback Channel: Choose an alternate channel to route the message if the user does not receive the message sent via the SMS channel.
      • Events: Select the types of events for which you would like to route the message to an alternate channel. These events include:
        • Delivery Failed
        • DR TTL Expired: Enter the number of seconds to implement a fallback to the alternate channel. For example, if you enter 20 seconds, the system implements the fallback mechanism to alternate channels you have configured.
        • Invalid Number
        • Message Validity Expired

    smssettings

Webhook for Outgoing Status Events$

Set up the webhook to receive notifications of the message delivery status.

  1. Events: Select the following events to receive notifications on the endpoint:
    • Delivery Status: Notification if the message is delivered or failed.
    • Sent: Notification when the message is sent to the end user from the platform.
    • Read: Notification when the end user reads your message.
    • Typing: Notification when the end user starts replying (Conversational type only).
  2. Payload Format: Select your desired format:
    • Native: Callback notifications to Campaign Manager
    • CleverTap: Callback notifications to CleverTap
    • MoEngage: Callback notifications to MoEngage
    • WebEngage: Callback notifications to WebEngage
  3. Intermediate Delivery Notification: (Optional) Enable to receive an intermediate callback notification in case of a fallback from one channel to another (Delivery Status events only).
  4. Protocol: Select the protocol for notifications:
    • NATS: High-performance messaging system. Example: nats://webhook.site/81xxxxxxxx-xxxxxx-xxxxx_test
    • HTTPS: Secures communication. Example: https://webhook.site/81xxxxxxxx-xxxxxx-xxxxx_test
  5. Metadata Header: (Optional) Enable to include metadata key:value pairs in the payload.
  6. Retries & Batch Notifications:
    • Retries: Retries failed webhook notifications (max 3).
    • Batch Notifications: Receive status of multiple events in a single notification (max 50 events per batch).

  7. Encrypt Payload: Ensures the confidentiality and integrity of data transmitted to the webhook receiver. Wisely supports Advanced Encryption Standard (AES) in which both sender and receiver use the same secret key to encrypt and decrypt the payload. Choose AES 128 or AES256 and enter the passphrase and version code to encrypt the payload.

    webhook1

    webhook2

    webhook3

    webhook4

Webhook for User-Initiated Messages$

Set up the webhook to receive notifications when the user responds to your message.

Note

This setting applies to the Conversation communication type only.

  1. Webhook URL: Select the desired protocol for receiving notifications:
    • NATS: High-performance messaging system. Example: nats://webhook.site/81xxxxxxxx-xxxxxx-xxxxx_test
    • HTTPS: Secures communication. Example: https://webhook.site/81xxxxxxxx-xxxxxx-xxxxx_test
  2. Payload Format: Select your desired format:
    • Native: User-initiated notifications to Campaign Manager
    • CleverTap: User-initiated notifications to CleverTap
    • MoEngage: User-initiated notifications to MoEngage
    • WebEngage: User-initiated notifications to WebEngage
  3. Retries: Retries enable the platform to resend any webhook notifications that failed to hand over to the webhook URL. A maximum of 3 retries are allowed.
  4. Metadata Header: (Optional) Enable to include metadata key:value pairs with the payload while sending an event to the platform.

  5. Encryption: Ensures the confidentiality and integrity of data transmitted to the webhook receiver. Wisely supports Advanced Encryption Standard (AES) in which both sender and receiver use the same secret key to encrypt and decrypt the payload. Choose AES 128 or AES256 and enter the passphrase and version code to encrypt the payload.

    user-initiated

    user-initiated

Manage App settings$

Enable/disable Apps that you have subscribed to in the App module. Currently, Wisley supports the following Apps:

  • Template Lookup: Searches for approved templates to be included in your message.
  • URL Shortener: Shortens the long and unreadable URLs that are included in your message.
  • Campaign Manager: Campaign Manager, a web-based application, empowers businesses to plan, execute, and track all enterprise campaigns.

  • Digital Asset Manager: The Digital Asset Library (DAM) App allows users to upload, organize, and manage media assets—including images, videos, and audio—for use across various messaging channels like WhatsApp, RCS, and Truecaller

    manageapp

Step 3: Click Create.$

Your access account and API key will be generated.