How to integrate your VoIP solution to noCRM

Connecting two apps together is never easy. Even if both sides have powerful and well-documented APIs, it takes more time to know how to create an integration that results in an excellent experience for the user. We know our app. You know yours. What is evident for us is probably not for you, whether you have already connected your app with other CRM’s or not. We all have our vocabulary and workflows.

To fix that problem, we’ve developed a smart API with two main specific endpoints to connect any VoIP solution to noCRM. This solution allows you to :

• Log any call in noCRM with a single request.
• Easily display information from noCRM in your application for incoming calls.

⚠️ This feature is only available in the Dream Team Edition

First of all contact us

We need to discuss with you on your project so we can guide you technically but also discuss support and potential co-marketing opportunities. Once we'll have discussed, we'll be able to register your VoIP solution and give you an authentication token for your app.

ℹ️ To use the VoIP API endpoints , you need to be a registered partner of noCRM

Send us an email at support@youdontneedacrm.com with some information about your company and your product so we can set up a call.

You can save some time by sending us the following information that we'll need to register your solution and create your key:

• Name of your product (will be displayed to customers)
• Logo of your product (will be displayed to customers)
• A description (Max 250 characters) of your product (will be displayed to customers)
• A short description of the integration you want to build.

→ We will quickly review it and send you a registered partner key.

How the integration will work

We have created 5 specific API routes for you to build your integration:

• First is to connect/disconnect a customer of yours to noCRM. It allows you to check if the noCRM API key of your customer is valid.
• Log a call: once a phone call has been done, you can send us all the information about it in just one call to our API. We'll handle where to add it in noCRM based on your customer's preferences in noCRM.
• Update a comment on a call : After a call has been made, some softphones allow the caller to add a comment, this comment will be automatically added to the call you logged previously.
• Get contact info: send us a phone number and we'll send you back all the info we have about that contact.
• Log a text message: once a text message is sent, you can send us the information of the text in one call to our API. We'll attached the text message based on the customer's preferences

→ Our API is fully documented here: https://www.nocrm.io/api

→ To connect / disconnect a customer of yours here: https://www.nocrm.io/api#partners

→ For handling calls here: https://www.nocrm.io/api#voip

Note: In addition to the API key used to authenticate, you will have to add your registered partner key to your request headers X-API-PARTNER-KEY

Without that header, all requests will be rejected. The key has to be kept secret, and we will reserve the right to deactivate it if we detect any miss-usage of it.

Logging calls in noCRM

It’s critical for noCRM users to keep track of their calls on their prospects or leads. It helps salespeople in their work but also team managers when it comes to reporting.

The idea is to send data to noCRM each time a call has ended, and noCRM will handle the data depending on rules that the customer has set up through their administration.

You don’t need to understand how noCRM works anymore, how the data is structured, what are the settings and preferences of the customer.

Each time a call ends (inbound or outbound) on your end, trigger a POST request to /api/v2/calls with the following data :

• called_number
• from_number
• direction - inbound or outbound
• user_id - email address of the user who makes (outbound) or receives (inbound) the call
• missed_call: set it to true when the call was not answered and we handle the notification or the log on our side and we set the proper activity
• started_at - when the call started (UTC date with this format YYYY-MM-DDTHH:MM:SS.sssZ)
• ended_at- when the call ended (UTC date with this format `YYYY-MM-DDTHH:MM:SS.sssZ)
• record_link - url address (if you provide this feature)
• ext_call_key - the identifier of the call in your application
• comment - a text that the customer could fill up to have feedback on the call and might add insight regarding the call
• If you have stored this data on your side
  • item_id - noCRM’s id of the item to attach the call to (must come with item_type)
  • item_type - noCRM’s type of the item to attach the call to (must come with item_id), possible values: Lead or Prospect

Note: bold fields are mandatory

This request will find the correct item in noCRM and record the call. It will return a JSON with the ID of the call created in noCRM, all the information sent, the item where the call has been attached, and the comment associated with the feedback sent. For detailed endpoint documentation, visit our API documentation here.

Update feedback after a call is made

After you call the endpoint to create a call, the user in your application may want to change the feedback left. It is possible to replace this feedback easily by calling this endpoint:

POST /api/v2/calls/{call_id}/comments/{id} with the following parameters:

• content - new content that will replace the previous one
• activity_id

The call_id corresponds to the ID returned in the response of the previous endpoint. The id of the comment is also returned in the response under the comment attribute.

More information is available in our API documentation here.

Display noCRM information in your app

When a user makes or receives a call, you can display information from noCRM about the contact. It gives the user information and context about who they will talk to.

You can display the information when the user visits a contact’s page, and also when an incoming call starts.

In noCRM you can find contact information on prospects or leads. To simplify your work, we’ve created a single endpoint for you to get the most relevant data

GET /api/v2/calls/get_contact?email=johndoe@acme.corp&phone=12982323

Given the phone number and the user making or receiving the call as parameters, we can return the contact information.

The returned data will contain:

• the permalink
• the title (Company name for example)
• contact information available on noCRM: Lastname, Firstname, Email, Job, Address,....
• status - the status of the item
• the id and type of the item, which you can link to your data for future calls to add to noCRM
  • the type of item (”Lead” or “Prospect”)
  • the ID of the item (the type and id of item can be stored on your side)

This is an easy way to display that information inside your application and give pertinent information about the call. Find out the complete structure in our API documentation here

Logging text messages in noCRM

Each time a text message is sent or received (inbound or outbound) on your end, trigger a POST request to /api/v2/texts with the following data :

• to_number
• from_number
• direction - inbound or outbound
• user_id - email address of the user who makes (outbound) or receives (inbound) the call
• sent_at - when the text message has been sent or received (UTC date with this format YYYY-MM-DDTHH:MM:SS.sssZ)
• ext_text_key - the identifier of the text message in your application
• content - the content of the text message
• If you have stored this data on your side
  • item_id - noCRM’s id of the item to attach the call to (must come with item_type)
  • item_type - noCRM’s type of the item to attach the call to (must come with item_id), possible values: Lead or Prospect

Note: bold fields are mandatory

This request will find the correct item in noCRM and record the text message. It will return a JSON with the ID of the text created in noCRM, all the information sent, the item where the text message has been attached, and the text_content of the text message sent. For detailed endpoint documentation, visit our API documentation here.

How can the user customize/set up the integration?

To make it easier for you to connect your VoIP solution to noCRM, while making it possible for the user to customize it to match their needs, we allow them to set up some rules in their noCRM administration. It will allow them to define their own rules in terms of attaching log calls or text messages inside noCRM and finding contact. It will also allow them to decide how to handle calls and texts when there is no information in noCRM or what to do when a call is missed. By putting all this logic out of your integration we allow you to build a quick but hyper-efficient integration.

Customers can access these preferences in noCRM from the Admin Panel, in their "Integrations" section > API > Phoning apps settings.