Create notification with include_aliases failed

[kienvtqhi]

How can we help?

Hello,

I am using create notification API with included_aliases to send the notification to the specified user by external_id.

aliasExternalIds := &onesignal.PlayerNotificationTargetIncludeAliases{
		AdditionalProperties: map[string]interface{}{
			"external_id": []string{receiverId},
		},
	}

notification.IncludeAliases = *onesignal.NewNullablePlayerNotificationTargetIncludeAliases(aliasExternalIds)

notification.IncludeExternalUserIds = []string{receiverId}

	targeChannel := "push"
	notification.TargetChannel = &targeChannel
	// notification.IncludedSegments = []string{"Total Subscriptions"}

	var iosBadgeCount *int32 = new(int32)
	*iosBadgeCount = 1
	notification.IosBadgeCount = *onesignal.NewNullableInt32(iosBadgeCount)

	iosBadgeType := "Increase"
	notification.IosBadgeType = *onesignal.NewNullableString(&iosBadgeType)

	appAuth := context.WithValue(context.Background(), onesignal.AppAuth, nd.oneSignalConfig.RestApiKey)

	successResponse, _, err := nd.oneSignalApiClient.DefaultApi.CreateNotification(appAuth).Notification(notification).Execute()

But it is failed. It return the invalid_aliases.

{
    "id": "b15ba6e5-2223-49d6-9eda-684b9051f5a8",
    "external_id": null,
    "errors": {
        "invalid_aliases": {
            "external_id": [
                "bnudasdfRUt4yUJh0912E63tzIXPsxq1"
            ]
        }
    }
}

What's wrong?
Please help me to fix it.

Thank you so much!

Code of Conduct

• I agree to follow this project's Code of Conduct

[jasperkuperus]

Same issue here. I'm trying to migrate from device-centric to the user-centric model. From the app everything works. Now I'm writing a migration script that loops over all subscription IDs of a user. For the first subscription, it gets the onesignal_id using GET https://onesignal.com/api/v1/apps/${onesignalAppId}/subscriptions/${subscriptionId}/user/identity.

Then it creates an alias by doing PATCH https://onesignal.com/api/v1/apps/${onesignalAppId}/users/by/onesignal_id/${oneSignalId}/identity.

For the rest of the subscriptions connected to a user, I transfer the subscriptions using PATCH https://onesignal.com/api/v1/apps/${onesignalAppId}/subscriptions/${subscriptionId}/owner.

I've tested this approach manually and it seems to work. I have now ran my script on 1 user and when I get that user by external_id, it properly shows me all subscriptions connected to that user.

However, when I now try to send a notification, I get this:

{"id":"","errors":{"invalid_aliases":{"external_id":["3cc7a2ba-91ea-4b18-93fc-c2123e458c6e","3cc7a2ba-91ea-4b18-93fc-c2123e458c6e","3cc7a2ba-91ea-4b18-93fc-c2123e458c6e","3cc7a2ba-91ea-4b18-93fc-c2123e458c6e","3cc7a2ba-91ea-4b18-93fc-c2123e458c6e"]}}}

Thoughts, @emawby?

[malikmajai]

It happens when notifications permission is not enabled by user on device.

[jasperkuperus]

@malikmajai I could see the logic there, but sending a notification to that external_id then fails as a whole. Even the linked subscriptions that do have permissions enabled don't get the notification. If you're sending a notification to 3 devices, where 1 device is not properly configured, the other 2 should still get the notification. Otherwise the whole user-centric model doesn't have any value.

[iuriandreazza]

This is still happening for today, do anyone has a workaround on this or should we just send to each individual user?

[orchie]

Similarly, there is an external_id but it cannot be pushed.

[shuo-hiwintech]

+1

[sherwinski]

I tested this out on v2 and was able to receive notifications, both in situations where at least one of the aliases is invalid and in situations where they are all valid. See example below:

    appId := "app_id"

    configuration := onesignal.NewConfiguration()
    apiClient := onesignal.NewAPIClient(configuration)

    restAuth := context.WithValue(context.Background(), onesignal.AppAuth, "app_auth_key")

    notification := onesignal.NewNotification(appId)

    contents := onesignal.NewStringMap()
    contents.SetEn("Hello! This is a test notification sent to specific aliases.")
    notification.SetContents(*contents)

    headings := onesignal.NewStringMap()
    headings.SetEn("Test Notification")
    notification.SetHeadings(*headings)

    receiverId := "valid_external_id"
    receiverId2 := "invalid_external_id"

    aliasExternalIds := &onesignal.PlayerNotificationTargetIncludeAliases{
        AdditionalProperties: map[string]interface{}{
            "external_id": []string{receiverId, receiverId2},
        },
    }

    notification.SetIncludeAliases(*aliasExternalIds)
    notification.SetIncludeExternalUserIds([]string{receiverId, receiverId2})

    targetChannel := "push"
    notification.SetTargetChannel(targetChannel)

    successResponse, r, err := apiClient.DefaultApi.CreateNotification(restAuth).Notification(*notification).Execute()

    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.CreateNotification`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        return
    }

    fmt.Println("✓ Notification sent successfully!")
    fmt.Printf("Notification ID: %s\n", *successResponse.Id)

    if successResponse.HasExternalId() {
        if externalId, ok := successResponse.GetExternalIdOk(); ok && externalId != nil {
            fmt.Printf("External ID: %s\n", *externalId)
        }
    }

    if successResponse.HasErrors() {
        fmt.Println("Errors encountered:")
        if errors, ok := successResponse.GetErrorsOk(); ok && errors != nil {
            fmt.Printf("  %v\n", *errors)
        }
    }

One thing worth pointing out is that you may not need this line notification.SetIncludeAliases(*aliasExternalIds) as a aliases are different from externdalIds. It seems targeting by both will still successfully send a notification but the API will respond with a onesignal.Notification200Errors.

[sherwinski]

I also want to mention that we have a new major release of this library (v5) that I would encourage users to upgrade to. Here is an example of how to achieve the same thing in the latest version:

    appId := "app_id"

    configuration := onesignal.NewConfiguration()
    apiClient := onesignal.NewAPIClient(configuration)

    restAuth := context.WithValue(context.Background(), onesignal.RestApiKey, "rest_api_key")

    notification := onesignal.NewNotification(appId)

    contents := onesignal.NewLanguageStringMap()
    contents.SetEn("Hello! This is a test notification sent to specific aliases.")
    notification.SetContents(*contents)

    headings := onesignal.NewLanguageStringMap()
    headings.SetEn("Test Notification")
    notification.SetHeadings(*headings)

    aliases := map[string][]string{
        "external_id": {
            "valid_external_id",
            "invalid_external_id",
        },
    }

    notification.SetIncludeAliases(aliases)

    targetChannel := "push"
    notification.SetTargetChannel(targetChannel)

    notification.SetName("Test Alias Notification")

    fmt.Println("Sending notification...")
    resp, r, err := apiClient.DefaultApi.CreateNotification(restAuth).Notification(*notification).Execute()

    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.CreateNotification`: %v\n\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        return
    }

    fmt.Println("✓ Notification sent successfully!")

    if resp.HasErrors() {
        errors, ok := resp.GetErrorsOk()
        if ok && errors != nil {
            fmt.Println("Errors encountered:")
            fmt.Printf("  %v\n", *errors)
        }
    }

[sherwinski]

Hopefully these examples help. I'm going to close this issue now but if there are any further questions or concerns, please feel free to comment here or open a new issue with details on how to reproduce.

[jasperkuperus]

The underlying issue for me was that I was switching between my TestFlight build and the App Store build. After a full uninstall and reinstall, this error went away.