Overview

Introducing the Call-Ai Users API: Simplifying User Data Management and Access Controls for Your Application

The Call-Ai Users API presents a seamless and efficient solution for developers to handle user data and access controls within their applications. This comprehensive API empowers developers with a wide array of functionalities, including user creation, user editing, team creation, team management, role assignment, and audit log management. These capabilities work in tandem with robust authentication and authorization mechanisms, ensuring a secure and personalized user experience for your application's users.

1. User Data Management Made Easy:

   The Users API revolutionizes the way developers handle user data. With just a few simple API calls, you can effortlessly create new users and edit existing ones. The API streamlines the entire process, reducing development time and enabling you to focus on other critical aspects of your application.

2. Effortless Team Creation and Management:

   Collaboration lies at the heart of many successful applications. With the Call-Ai Users API, you can effortlessly create teams and manage their memberships. This enables your application to support various team-based functionalities, fostering a sense of unity among users and enhancing productivity.

3. Seamlessly Assign Roles:

   Roles play a pivotal role in defining user permissions and access levels. With the Users API, you can efficiently assign roles to individual users or entire teams. This feature allows you to tailor access controls precisely according to your application's requirements, ensuring that users can only access the features and data relevant to their roles.

4. Audit Log Management:

   Maintaining a comprehensive audit trail is vital for security and accountability. The Users API enables you to manage audit logs effortlessly. You can track user actions, access attempts, and other critical events in your application, facilitating troubleshooting, compliance, and security analysis.

5. Enhanced Security and Personalization:

   User authentication and authorization are paramount concerns for any application. The Call-Ai Users API incorporates robust security measures to protect user data and privacy. By seamlessly integrating with your existing authentication systems, the API ensures that only authorized users can access your application's resources. This results in a personalized and secure user experience, fostering trust and loyalty among your user base.

6. Seamless Integration and Scalability:

   The Users API is designed with simplicity and scalability in mind. Its developer-friendly interface allows for easy integration into your application, regardless of its size or complexity. As your user base grows, the API can effortlessly scale to meet the increasing demands, ensuring smooth and uninterrupted user data management.

7. Comprehensive Documentation and Support:

   We understand the importance of clear and detailed documentation for developers. The Users API comes with comprehensive documentation, complete with code examples and usage guidelines. Moreover, our dedicated support team is always ready to assist you with any questions or issues you may encounter during integration and development.

In conclusion, the Call-Ai Users API empowers developers with a powerful toolkit for efficient user data management and access controls. Its range of functionalities, combined with robust security measures, ensures a secure and personalized user experience for your application. By simplifying complex processes, the API allows you to focus on delivering a remarkable user experience and driving the success of your application. So, why wait? Integrate the Call-Ai Users API today and take your application to new heights of excellence.

Create a New User/Agent

The create new user API facilitates the addition of a new user to a system or application.

Endpoint URL

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Params)

It takes a JSON request body with the following notable parameter:

Sample Request

POST https://api.call-ai.com/authentication-ms/v1/auth/api/v1/authentication/

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer ••••••••••••
Ocp-Apim-Subscription-Key: ••••••••••••

{
  "user": {
      "ip": "34.543.66.74",
      "email": "admin123@gmail.com",
      "name": "vinod",
      "phone": {
          "number": "08989898989",
          "internationalNumber": "+91 89898 98989",
          "nationalNumber": "089898 98989",
          "e164Number": "+918989898989",
          "countryCode": "IN",
          "dialCode": "+91"
      },
      "position": "DEV",
      "created_by": "admin",
      "reporting_manager": "admin",
      "user_metadata": {
          "password": "Admin@123",
          "organization_name": "dev-org",
          "organization_display_name": "devorg",
          "organization_id": "org_IyyPNiNdz9w9mcqs",
          "tenant_id": "tenant_12345",
          "employee_id": "emp_123",
          "role": ["customer_admin", "sales"]
      }
  }
}

                  

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Update User/Agent

The update user API enables the modification of user information in a system or application.

Endpoint URL

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Params)

It takes a JSON request body with the following notable parameter:

Sample Request

PATCH https://api.call-ai.com/authentication-ms/v1/auth/api/v1/authentication/

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer ••••••••••••••
Ocp-Apim-Subscription-Key: ••••••••••••••

{
    "user": {
        "phone": {
            "number": "090908 76534",
            "internationalNumber": "+91 90908 76534",
            "nationalNumber": "090908 76534",
            "e164Number": "919090876534",
            "countryCode": "IN",
            "dialCode": "+91"
        },
        "user_id": "auth0|645cbb7a0be902874f4b9f28",
        "status": "ACTIVE",
        "reporting_manger": "okokoks",
        "email": "admin123@gmail.com",
        "ip": "122.160.141.52",
        "name": "okokokoko",
        "role": ["customer_admin", "sales"],
        "modified_by": "sandeep.rawat@call-ai.com",
        "position": "okok notq",
        "employee_id": "tr12345EHRue"
    },
    "tenant_id": "tenant_12345"
}

                    

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Delete User/Agent

The "Delete User API" is an allows you to remove a user from a system or application.

Endpoint URL

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Params)

It takes a JSON request body with the following notable parameter:

Sample Request

DELETE https://api.call-ai.com/authentication-ms/v1/auth/api/v1/authentication/

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer ••••••••••••••
Ocp-Apim-Subscription-Key: ••••••••••••••

{
  "user": {
    "email": "admin123@gmail.com",
    "ip": "122.160.141.52",
    "modified_by": "parvis.kakkar@call-ai.com",
    "tenant_id": "tenant_12345",
    "user_id": "auth0|645cbb7a0be902874f4b9f28"
    }
}

                    

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Fetch List of User/Agent (with filter)

The "Filter User API"allows you to filter user on the basis of role,login time and status.

Endpoint URL

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Params)

It takes a JSON request body with the following notable parameter:

Sample Request

POST https://api.call-ai.com/authentication-ms/v1/auth/api/v1/authentication/users/fetch/filter

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer ••••••••••••••
Ocp-Apim-Subscription-Key: ••••••••••••••

{
  "pageSize": 1,
    "pageIndex": 10,
    "selectedRolebyuser": ["agent", "customer"],
    "status": ["Active", "Inactive", "VerificationPending"],
    "field": "name",
    "order": "1",
    "org_id": "org_12345"
}
                      

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

User/Agent Active/Inactive

This API allows the updating of the user's status to either ACTIVE or INACTIVE.

Endpoint URL

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Params)

It takes a JSON request body with the following notable parameter:

Sample Request

PATCH https://api.call-ai.com/authentication-ms/v1/auth/api/v1/authentication/statusUpdate

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer ••••••••••••••
Ocp-Apim-Subscription-Key: ••••••••••••••

{
  "ip": "122.160.141.52",
    "email": "admin123@gmail.com",
    "status": false,
    "tenant_id": "tenant_12345",
    "user_id": "auth0|643e891c170832ee0b05a804",
    "activity": "Status has been changed by testing user test from ACTIVE to INACTIVE",
    "modified_by": "admin123@gmail.com"
}
                      

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Fetch User/Agent Details

The "Find User By Email"allows user lookup based on their email address.".

Endpoint URL

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Params)

It takes a JSON request body with the following notable parameter:

Sample Request

GET https://api.call-ai.com/authentication-ms/v1/auth/api/v1/authentication/user/{email}/{tenant_id}

Cache-Control: no-cache
Authorization: Bearer ••••••••••••••
Ocp-Apim-Subscription-Key: ••••••••••••••

                      

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Resent Verification Link

The "Resend Verification Link"allows to resend verification link to user's email.

Endpoint URL

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Params)

It takes a JSON request body with the following notable parameter:

Sample Request

GET https://api.call-ai.com/authentication-ms/v1/auth/api/v1/authentication/resend/verification/{auth_id}

Cache-Control: no-cache
Authorization: Bearer ••••••••••••••
Ocp-Apim-Subscription-Key: ••••••••••••••

                      

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Reset Password

his API enables the updating of a user's password with new credentials.

Endpoint URL

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Params)

It takes a JSON request body with the following notable parameter:

Sample Request

PATCH https://api.call-ai.com/authentication-ms/v1/auth/api/v1/authentication/password

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer ••••••••••••••
Ocp-Apim-Subscription-Key: ••••••••••••••

{
  "user": {
    "email": "admin123@gmail.com",
      "current_password": "Admin@123",
        "new_password": "Admin@123",
        "user_id": "auth0|643d280e23106bb01368df74",
        "base_password_changed": true
    },
    "tenant_id": "tenant_12345"
}
                      

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below: